See api-docs Menu

Verify Email Settings Config

Use this API to test your org’s current Email Settings config.

The response always succeeds. if there is a configuration error, the test email is sent, but it reverts back to the default onelogin Email Settings server. A failure event is generated if the test fails.








Resource URL

https://<api-domain>/api/2/branding/email_settings/test

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All, Read All.

Failed Email Settings Event

When you test the Email Settings config and there is an error, it produces an Event in the OneLogin admin portal. To view the event, in the admin portal go to ActivityEvents.

The event pictured below informs the admin that the operation failed.

Sample Responses

{
   "message": "Success",
   "statusCode": 200,
   "name": "Success"
}

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

The requested Email Settings config doesn’t exist.

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Branding API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Verify Email Settings Config

curl 'https://<api-domain>/api/2/branding/email_settings/test' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.