See api-docs Menu

API Authorization Resource

This is the base resource for configuring api authorization in OneLogin.

Early Access Release

This API is currently in early preview release and may be subject to future breaking changes. If you’re interested in using this API please contact your account manager or our support team.

Resource Elements

{
  "id": 1022697,
  "name": "Contacts API",
  "description": "This is an api",
  "configuration": {
    "resource_identifier": "https://example.com/contacts",
    "audiences": [
      "https://example.com/contacts"
    ],
    "refresh_token_expiration_minutes": 30,
    "access_token_expiration_minutes": 10
  }
}

id

integer

Auth Server unique ID in OneLogin.

name

required

string

Name of the API.

description

required

string

Description of what the API does.

configuration

required

object

See configuration section below.

Configuration

resource_identifier

required

string

Unique identifier for the API that the Authorization Server will issue Access Tokens for.

ex. http://example.com/contacts

audiences

required

array

List of API endpoints that will be returned in Access Tokens.

ex. http://example.com/contacts

access_token_expiration_minutes

integer

The number of minutes until access token expires.

refresh_token_expiration_minutes

integer

The number of minutes until refresh token expires.

Postman Collection

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

Download for the Apps API


Have a Question?

Found a bug? Submit a support ticket.

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