See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Branding >
  5. List Message Templates

List Message Templates

Early Preview

This API is in early preview and may be subject to change. Please contact your account manager if you are interested in trying the Branding API.

Use this API to return a list of message templates.








Resource URL

https://<subdomain>/api/2/branding/brands/:brand_id/templates

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.

In order to use the Branding API your API Credentials must be created after 21st October 2020.

Content-Type

required

string

 Set to application/json.

Resource Parameters

brand_id

required

integer

Unique identifier for the branding object.

Query Parameters

locale

optional

integer

The message locale to return.

Example: https:///api/2/branding/brands/:brand_id/templates?locale={locale}

Sample Responses

  • 200 OK
  • 401 Unauthorized
  • 422 Unprocessable Entity
[
  {
      "id": 912,
      "enabled": true,
      "name": "ACME"
  },
  ...
]

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

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

Indicates that the syntax of the request is good but a value supplied is not valid.

{
    "message": "invalid value in \"auth_method\"",
    "statusCode": 422,
    "name": "UnprocessableEntityError"
}

Response Elements

id

Brand’s unique ID in OneLogin.
name Brand name for humans. This isn’t related to subdomains.
enabled Indicates if the brand is enabled or not.

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.

List Account Brands

curl 'https://<subdomain>/api/2/branding/brands/:brand_id/templates' \
-X GET \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \

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.