REST API for Oracle Identity Cloud Service

Generate User Details Using Access Token

get

/oauth2/v1/userinfo

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

User information generated

Root Schema : userinfo

Type: object

Generate the user information in JSON format.

Show Source

birthdate: string

Birthdate of the user
family_name: string

Family name of the user
gender: string

Gender of the user
given_name: string

First name of the user
name: string

Name of the user
preferred_username: string

User's preferred name
sub: string

Subject provided by the user
website: string

Website provided by the user

{
    "description":"Generate the user information in JSON format.",
    "type":"object",
    "properties":{
        "birthdate":{
            "type":"string",
            "description":"Birthdate of the user"
        },
        "family_name":{
            "type":"string",
            "description":"Family name of the user"
        },
        "gender":{
            "type":"string",
            "description":"Gender of the user"
        },
        "given_name":{
            "type":"string",
            "description":"First name of the user"
        },
        "name":{
            "type":"string",
            "description":"Name of the user"
        },
        "preferred_username":{
            "type":"string",
            "description":"User's preferred name "
        },
        "sub":{
            "type":"string",
            "description":"Subject provided by the user"
        },
        "website":{
            "type":"string",
            "description":"Website provided by the user"
        }
    },
    "required":[
        "birthdate",
        "family_name",
        "gender",
        "given_name",
        "name",
        "preferred_username",
        "sub",
        "website"
    ]
}

400 Response

Invalid request

Root Schema : error

Type: object

Error message that appears during Revoke Refresh Token

Show Source

error: string

Error values based on the OAuth specification
error_description: string

Detailed error messages

{
    "description":"Error message that appears during Revoke Refresh Token",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

Examples

The following example shows how to obtain user information using an access token by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. See the Authorization section for more information on grant types.

Example Request Using cURL

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.

The following shows an example cURL request using an access token to obtain user information

curl -i 
-H 'Authorization: Bearer <Access Token Value>' 
-H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8'
--request GET https://tenant-base-url/oauth2/v1/userinfo'

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "birthdate": "",
    "family_name": "opc",
    "gender": "",
    "given_name": "admin",
    "name": "admin opc",
    "preferred_username": "admin@example.com",
    "sub": "admin@example.com",
    "website": ""
  }