Jump to

• Request
• Response
• Examples

Find User Consent's

get

/oauth2/rest/consent

The REST API enables End User to fetch consents. The API return's all the consents for a given User or specific consents for a given User, OAuth Client and OAuth Application combination.

Request

Supported Media Types

• application/x-www-form-urlencoded

Query Parameters

• clientIdentifier: string
  OAuth Client ID/Identifier
• identityDomain: string
  Identity Domain under which the token is being requested. This is an optional parameter if 'x-oauth-identity-domain-name' header parameter is provided.
• resServerId: string
  OAuth Application ID/Identifier

Header Parameters

• oam_remote_user(required): string
  Specify User name/identifier (either via oam_remote_user (header) or oam_id (cookie)) who's consents needs to be retrieved.
• x-oauth-identity-domain-name(required): string
  OAuth Identity Domain name under which user consents are expected.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sucessfully retrieved user consent - detail

Body ()

Root Schema : consent

Type: array

Array of user consent

Show Source

• Array of: object consent

{
    "description":"Array of user consent",
    "type":"array",
    "xml":{
        "name":"consent",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/consent"
    }
}

Nested Schema : consent

Type: object

Show Source

• clientId(required): string
  OAuth Client Identifier
• consentId(required): string
  OAuth Consent Unique Identifier
• createTimeStamp(required): string
  Creation timestamp for OAuth Consent
• resourceId(required): string
  OAuth Application Identifier
• scopes(required): array scope
• valid(required): boolean
  Flag to identify OAuth Consent validity. True - Consent is valid, False - Consent is In-valid

{
    "type":"object",
    "required":[
        "clientId",
        "consentId",
        "createTimeStamp",
        "resourceId",
        "scopes",
        "valid"
    ],
    "properties":{
        "clientId":{
            "type":"string",
            "description":"OAuth Client Identifier"
        },
        "consentId":{
            "type":"string",
            "description":"OAuth Consent Unique Identifier"
        },
        "createTimeStamp":{
            "type":"string",
            "description":"Creation timestamp for OAuth Consent"
        },
        "resourceId":{
            "type":"string",
            "description":"OAuth Application Identifier"
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scope",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/scope"
            }
        },
        "valid":{
            "type":"boolean",
            "description":"Flag to identify OAuth Consent validity. \n True - Consent is valid, \n False - Consent is In-valid"
        }
    }
}

Nested Schema : scope

Type: array

Show Source

• Array of: string
  OAuth Scope string.

{
    "type":"array",
    "xml":{
        "name":"scope",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/scope"
    }
}

400 Response

Failed to retrieve user consent - detail

Body ()

Root Schema : schema

Type: object

Show Source

• error: string
  Error code
• error_description: string
  Error description

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error code"
        },
        "error_description":{
            "type":"string",
            "description":"Error description"
        }
    },
    "example":{
        "error":"400",
        "error_description":"Required parameter 'X-OAUTH-IDENTITY-DOMAIN-NAME' is not present."
    }
}

Example:

{
    "error":"400",
    "error_description":"Required parameter 'X-OAUTH-IDENTITY-DOMAIN-NAME' is not present."
}

Back to Top

Examples

The following example shows a sample request and response to fetch all the consents for a specific user, under an OAuth Identity Domain Name.

cURL Example to Fetch All the Consents

curl --location --request GET 'http://<lbr-host>:<lbr-port>/oauth2/rest/consent' \
--header 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain' \
--header 'OAM_REMOTE_USER: DemoUser'

Sample Response

{
    "consents": [
        {
            "consentId": "ebe683b9-0345-3c35-a21d-35e57958ed21",
            "clientId": "DemoClient",
            "resourceId": "506a50c2-a892-49ee-85ad-9993169a18bf",
            "scopes": [
                "DemoResource.editDemoRes",
                "DemoResource.delDemoRes",
                "DemoResource.viewDemoRes"
            ],
            "additionalScopes": null,
            "createTimeStamp": "Wed Apr 08 23:06:54 PDT 2020",
            "valid": true
        },
        {
            "consentId": "8c1d5d3a-dc74-3939-aa72-03c12fcff3b3",
            "clientId": "DemoClient",
            "resourceId": "OPENID_MGMT_RESOURCE",
            "scopes": [
                "openid",
                "profile",
                "email"
            ],
            "additionalScopes": null,
            "createTimeStamp": "Wed Apr 08 23:06:54 PDT 2020",
            "valid": true
        }
    ]
}

The following example shows a sample request and response to fetch consents for each user and client-application.

cURL Command to Fetch Consents for Each User and Client-Application

curl --location --request GET 'https://<lbr-host>:<lbr-port>/oauth2/rest/consent?resServerId=506a50c2-a892-49ee-85ad-9993169a18bf&clientIdentifier=DemoClient' \
--header 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain' \
--header 'OAM_REMOTE_USER: DemoUser'

Sample Response

{
    "consents": [
        {
            "consentId": "ebe683b9-0345-3c35-a21d-35e57958ed21",
            "clientId": "DemoClient",
            "resourceId": "506a50c2-a892-49ee-85ad-9993169a18bf",
            "scopes": [
                "DemoResource.editDemoRes",
                "DemoResource.delDemoRes",
                "DemoResource.viewDemoRes"
            ],
            "additionalScopes": null,
            "createTimeStamp": "Wed Apr 08 23:06:54 PDT 2020",
            "valid": true
        }
    ]
}

Back to Top