See api-docs Menu

Update a Client App

Update the scopes available to this OpenId Connect client app.

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/clients/:client_app_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.

Content-Type

required

string

Set to application/json.

Resource Parameters

id

required

integer

The id of the authorization server.

client_app_id

required

integer

The id of the client app.

Request Parameters

scopes

required

array

An array of Scope IDs that represent the scopes the app can request

Request Body

{
    "scopes": [123, 456]
}

Sample Responses

{
    "app_id": 909021,
    "api_auth_id": 1022697
}

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

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

Invalid API Authorization Server ID or Invalid OIDC App ID

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

An invalid scope id has been provided

{
    "message": "Validation failed: Scopes 51 does not belong to the specified ApiAuthorizationApp",
    "statusCode": 422,
    "name": "UnprocessableEntityError"
}

Response Elements

id Unique ID for the Client App

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.

Update a Client App

curl 'https://api.<us_or_eu>>.onelogin.com/api/2/api_authorizations/:id/clients/:client_app_id' \
-X PUT \
-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.