Get application scopes
The endpoint provides functionality to get which scopes are assigned to an OAuth 2.0 / OIDC application.
HTTP request
GET https://$instanceId.id.nevis.cloud/nevis/api/v1/applications/$applicationId/scopes
Parameters
Parameter | In | Type | Required / Optional | Description |
---|---|---|---|---|
instanceId | path | string | required | The ID of your Identity Cloud instance |
applicationId | path | string | required | The ID of the application |
Example request
Set the ID of the application
applicationId=your-application-id-123
curl --request GET "https://$instanceId.id.nevis.cloud/nevis/api/v1/applications/$applicationId/scopes" \
--header "Authorization: Bearer $accessKey"
HTTP response
On success
HTTP/1.1 200
is returned if the application with scopes is found.
Response body
Parameter | Type | Description |
---|---|---|
profile | boolean | True if the profile scope for openid is assigned to the application. |
email | boolean | True if the email scope for openid is assigned to the application. |
address | boolean | True if the address scope for openid is assigned to the application. |
phone | boolean | True if the phone scope for openid is assigned to the application. |
openid | boolean | True if the openid scope is assigned to the application. |
offlineAccess | boolean | True if offlineAccess scope is assigned to the application. |
customScopes | array of custom scopes | The collection of custom scopes. |
Example response
{
"offlineAccess": true,
"address": true,
"phone": true,
"openid": true,
"profile": true,
"email": true
"customScopes": [
{
"scopeId": "ecb557b9de1631201d66bccb",
"name": "read",
"assigned": true
},
{
"scopeId": "7a89b5db9b10bb3667b22181",
"name": "write",
"assigned": false
}
]
}
On failure
HTTP/1.1 401
is returned if the authorization failed due to an invalid access key.
HTTP/1.1 404
is returned if the OAuth 2.0 / OIDC application with given id is not found.
HTTP/1.1 500
is returned if an unexpected error occurred.