Jump to

• Request
• Response

Get the Initial access token which can be used for registration of OAuth client using DCR flow

get

/oauth2/rest/dcr/token

Token can be acquired in either JSON response format or QR Code depending on the

Request

Supported Media Types

• application/json
• application/x-www-form-urlencoded

Query Parameters

• domain(required): string
  Domain name under which you want to register the client
• identityDomain: string
  This is an alternate to 'domain' query parameter. If this is provided domain is not required.
• output_type: string
  Output format of access token which will be generated, two formats are supported currently, 'image/png' and 'application/json'. Default is application/json
• template_id(required): string
  Template id of OAuth client template registered by Admin for auto configration generation of actual client

Back to Top

Response

Supported Media Types

• application/json

200 Response

Initial access token

Body ()

Root Schema : accesstoken

Type: object

Show Source

• access_token(required): string
  eyJraWQiOiJkY3JfZG9tYWluIiwieDV0IjoibnFpalFTVkNDMGVrS1
• expires_in(required): integer
  expiry time of token in sec
• token_type(required): string
  Bearer

{
    "type":"object",
    "required":[
        "access_token",
        "token_type",
        "expires_in"
    ],
    "properties":{
        "access_token":{
            "type":"string",
            "description":"eyJraWQiOiJkY3JfZG9tYWluIiwieDV0IjoibnFpalFTVkNDMGVrS1"
        },
        "token_type":{
            "type":"string",
            "description":"Bearer"
        },
        "expires_in":{
            "type":"integer",
            "description":"expiry time of token in sec"
        }
    }
}

403 Response

If either OAuth Service is not enabled or DCR is not enabled for current domain

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode: string
• errorDesc: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

404 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode: string
• errorDesc: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode: string
• errorDesc: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Back to Top