Getting information about users who obtained an access token

Execution permission

None.

Request line

GET base-URL/auth/v1/providers/builtin/userinfo

Request message

Object ID

None.

Query parameters

None.

Body

None.

Response message

Body

{
    "sub": "63583645-fc6f-416d-94a1-1e0719247f4d",
    "name": "john smith",
    "given_name": "john",
    "family_name": "smith",
    "preferred_username": "john_smith",
    "email": "john_smith@example.com",
    "email_verified": false,
    "https://opscenter/user_groups": [
        "92d2677b-a3a2-4643-a908-49ade439e0d4"
    ],
    "https://opscenter/user_is_enabled": true,
    "https://opscenter/roles": [
        "opscenter-user",
        "offline_access",
        "uma_authorization"
    ]
}

Attribute	Type	Description
sub	string	Object ID of the user
name	string	Full name of the user
given_name	string	First name of the user
family_name	string	Last name of the user
preferred_username	string	Username
email	string	Email address
email_verified	boolean	Whether or not the email address is verified true: Verified false: Not verified
https://opscenter/user_groups	string[]	ID of the user group that the user belongs to
https://opscenter/user_is_enabled	boolean	Whether the user account is enabled true: The user account is enabled. false: The user account is disabled.
https://opscenter/roles	string[]	ID of the role that was assigned to the user

Coding example

curl -v -X GET -s "https://example.com:443/portal/auth/v1/providers/builtin/userinfo" -H "Authorization:Bearer eyJhbxxx"