Sign in
Client Management

Get Granted Scopes

Get the set of scopes that a user has granted to a client application.

Description

Possible values for requestableScopes parameter in the response from this API are as follows. null The user has not granted authorization to the client application in the past, or records about the combination of the user and the client application have been deleted from Authlete's DB. An empty set The user has granted authorization to the client application in the past, but no scopes are associated with the authorization. A set with at least one element The user has granted authorization to the client application in the past and some scopes are associated with the authorization. These scopes are returned. Example: [ "profile", "email" ] The subject parameter is required and must be provided as a query parameter.

get/api/{serviceId}/client/granted_scopes/get/{clientId}

Path parameters

serviceIdstring required

A service ID.

clientIdstring required

A client ID.

Query parameters

subjectstring required

Unique user ID of an end-user.

Response

Successfully retrieved granted scopes

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

serviceApiKeyinteger

A short message which explains the result of the API call.

clientIdinteger

Get the client ID.

subjectstring

Get the subject (= unique identifier) of the user who has granted authorization to the client.

latestGrantedScopesstring[]

Get the scopes granted to the client application by the last authorization process by the user (who is identified by the subject).

mergedGrantedScopesstring[]

Get the scopes granted to the client application by all the past authorization processes. Note that revoked scopes are not included.

modifiedAtinteger

Get the timestamp in milliseconds since Unix epoch at which this record was modified.

Changes