See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Branding >
  5. Get Email Settings Config

Get Email Settings Config

Due to SMTP updates, this API has been removed. A new API will be provided when available.

Use this API to return your org’s current Email Settings configuration.









Resource URL

https://<subdomain>/api/2/branding/email_settings

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.

Sample Responses

  • 200 OK
  • 401 Unauthorized

OneLogin default Email Settings configuration

{
    "mode": "onelogin_email"
}

Custom Email Settings configuration

{
   "address": "smtp.sendgrid.net",
   "use_tls": true,
   "from": "email@example.com",
   "domain": "example.com",
   "user_name": "user-name",
   "mode": "custom_smtp_config",
   "password": "password",
   "port": 587
}

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

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

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.

Get Email Settings Config

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

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

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