See api-docs Menu

Get Authorization Server

Use this API to return an API authorization configuration.

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 URL

https://api.<us_or_eu>.onelogin.com/api/2/api_authorizations/:id

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.

Resource Parameters

id

required

integer

The id of the authorization server to locate.

Sample Responses

See API Authorization Resource for attribute definitions.

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

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

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}
{
    "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 API Authorization Management

Sample Code

cURL

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

List API Authorization Servers

curl 'https://api.<us_or_eu>>.onelogin.com/api/2/api_authorizations/:id' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a bug? Submit a support ticket.

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