Retrieves a specific OIDC grant.

get https://{tenanturl}/v1.0/appgrants/{gid}

Retrieves a specific OIDC or OAuth grant of OIDC applications that the user owns.

Responses

Response body

object

string

The grant identifier.

appId

string

The application ID. For API client grants, this property is null.

clientId

string

The API client's or OIDC application's client ID.

clientName

string

The OIDC application name or API client name.

category

string

The category of the OIDC client.

application api_client ibm_verify default

name

string

The name of the user. For API client grants, this value is null.

username

string

The user's unique ID. For API client grants, this value is the client ID.

preferred_username

string

The preferred user name. For API client grants, this value is null.

realmName

string

The realm name.

originIP

string

The origin IP address where this grant was created.

location

array of strings

The location where this grant was created. The array contains in this sequence, the country, state, and city of the location.

location

countryCode

string

The country code where this grant was created.

tokens

array of strings

A list of token types that have been associated with the grant. The list can include tokens other than the currently active token types.

tokens

issuedOn

string

The time when the grant was issued.

lastUsed

string

The time when the grant was last used.

disabledOn

string

The time when the grant was disabled.

retainUntil

string

The time when the grant will be deleted.

enabled

boolean

Specifies whether the grant is enabled.

readOnly

boolean

Flag to indicate the grant is only viewable or can be modified.

attributes

array of objects

A list of attributes that are associated with the grant.

attributes

object

value

string

The attribute id.

name

string

The attribute name.

values

array of strings

The attribute values.

values

sensitive

boolean

Specifies whether attribute values contain sensitive data.

readOnly

boolean

Specifies whether attribute values can be modified.

scope

string

Scope associated with the grant.

sessionId

string

Session Id associated with this grant.

uaSessionId

string

User-Agent session Id associated with this grant.

getgrantGroupID

string

Grant Group Id, an attribute that can be associated with multiple grants

deviceName

string

Device used to acquire this grant.

403

Access was forbidden.

404

The grant was not found.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v1.0/appgrants/gid \
3
     --header 'accept: application/json'

Choose an example:

application/json

200The grant was returned.

500An internal server error occurred.