Jump to

• Request
• Response

Register the client using registration token acquired for given domain

post

/oauth2/rest/dcr/client

Request

Supported Media Types

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

Query Parameters

• identityDomain: string
  This is an alternate to 'X-OAUTH-IDENTITY-DOMAIN-NAME' header parameter. If this is provided 'X-OAUTH-IDENTITY-DOMAIN-NAME' is not required. 'X-OAUTH-IDENTITY-DOMAIN-NAME' will take precedance over 'identityDomain' query parameter.

Header Parameters

• Autherization(required): string
  Initial access token
• X-OAUTH-IDENTITY-DOMAIN-NAME(required): string
  Domain name with which you want to register the client, It MUST be same as domain for which token is acquired

Back to Top

Response

Supported Media Types

• application/json

200 Response

Initial access token

Body ()

Root Schema : clientinfo

Type: object

Show Source

• client_get_uri(required): string
  uri at which you can fetch the client details
• client_id(required): string
  a7befc996f674ac38720a2b64ff388e4
• client_name(required): string
  oma4ac38720a2b64ff388e4
• client_secret(required): string
  oudA8WlqpENkEz
• client_secret_expires_at: integer
  time in sec
• redirect_uris(required): array redirect_uris

{
    "type":"object",
    "required":[
        "client_id",
        "client_secret",
        "client_name",
        "redirect_uris",
        "client_secrete_expires_at",
        "client_get_uri"
    ],
    "properties":{
        "client_id":{
            "type":"string",
            "description":"a7befc996f674ac38720a2b64ff388e4"
        },
        "client_secret":{
            "type":"string",
            "description":"oudA8WlqpENkEz"
        },
        "client_name":{
            "type":"string",
            "description":"oma4ac38720a2b64ff388e4"
        },
        "redirect_uris":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"android-app://com.example.app/example.com/my/path/to/information, http://localhost:8080/my/path/to/information"
            }
        },
        "client_secret_expires_at":{
            "type":"integer",
            "description":"time in sec"
        },
        "client_get_uri":{
            "type":"string",
            "description":"uri at which you can fetch the client details"
        }
    }
}

Nested Schema : redirect_uris

Type: array

Show Source

• Array of: string
  android-app://com.example.app/example.com/my/path/to/information, http://localhost:8080/my/path/to/information

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"android-app://com.example.app/example.com/my/path/to/information, http://localhost:8080/my/path/to/information"
    }
}

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

One of scenario in which you will get this error is when you use the same initian access token multiple times

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode: string
• errorDesc: string

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

Back to Top