See api-docs Menu

Update an Authorization Server Scope

Update an Authorization Server scope.

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/scopes/:scope_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.

scope_id

required

integer

The id of the scope.

Request Parameters

value

required

string

A value representing the api scope that with be authorized

description

required

string

A description of what access the scope enables

Request Body

{
    "value": "custom:scope",
    "description": "A custom scope"
}

Sample Responses

{
    "id": 323005
}

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

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

Invalid API Authorization Server ID or Invalid Scope ID

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

A scope with this name already exists

{
    "message": "Validation failed: Value has already been taken",
    "statusCode": 422,
    "name": "UnprocessableEntityError"
}

Response Elements

id Unique ID for the Scope

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 Scope

curl 'https://api.<us_or_eu>>.onelogin.com/api/2/api_authorizations/:id/scopes/:scope_id' \
-X PUT \
-H "Authorization: bearer <access_token>" \ -d '{
    "value": "custom:scope",
    "description": "A custom scope"
}'

Have a Question?

Found a bug? Submit a support ticket.

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