See api-docs Menu

API Authorization Resource

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





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. There is no maximum expiry limit.

refresh_token_expiration_minutes

integer

The number of minutes until refresh token expires. There is no maximum expiry limit.

Postman Collection

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

Run in Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a bug? Submit a support ticket.

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