DocumentationAdobe PassAdobe Pass Authentication

Retrieve client credentials retrieve-client-credentials

Last update: Tue Sep 24 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
The content on this page is provided for information purposes only. Usage of this API requires a current license from Adobe. No unauthorized use is permitted.
IMPORTANT
Dynamic Client Registration API implementation is bounded by the Throttling mechanism documentation.

Request request

HTTP
path
/o/client/register
method
POST
Body Parameters
software_statement
The software statement associated with the registered application created and downloaded from Adobe Pass TVE Dashboard.

The management of registered applications is described in the Dynamic Client Registration Overview documentation.
required
redirect_uri
The redirect URI associated with the location to which the user agent navigates when the authentication flow is completed.
optional
Headers
Content-Type
The accepted media type for the resources being sent.

It must be application/json.
required
X-Device-Info
The generation of the device information payload is described in the X-Device-Info documentation.

It is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.

When provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).

When not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).
required
Accept
The media type accepted by the client application.

If specified, it must be application/json.
optional
User-Agent
The user agent of the client application.
optional

Response response

Success success

Headers
Status
201
required
Content-Type
application/json
required
Body

JSON object having the following attributes:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff 25-bgcolor-deebff layout-auto html-authored
Attribute
client_id The client application identifier string. required
client_secret The client application secret string. required
client_id_issued_at The time at which the client application identifier was issued. required
redirect_uris The array of redirection URI strings that the client application can use in redirect-based flows. required
grant_types The grant type strings that the client application can use for the client token endpoint. required
scopes The scope strings defining the Adobe Pass Authentication APIs that the client application can use. required
required

Error error

Headers
Status
400
required
Content-Type
application/json
required
Body
error

The possible values are:

table 0-row-3 1-row-2 2-row-2 3-row-2 4-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 8-bgcolor-deebff 11-bgcolor-deebff 14-bgcolor-deebff layout-auto html-authored
Value
invalid_request

The request is invalid due to one of the following reasons:

  • The request misses a required parameter.
  • The request includes an unsupported parameter value.
  • The request repeats a parameter.
  • The request is malformed.
invalid_redirect_uri The request includes a value for the redirection URI which is invalid.
invalid_software_statement The request includes a value for the software statement which is invalid.
unapproved_software_statement The request includes a value for the software statement which is not approved for use by the Adobe Pass Authentication server.
required

Samples samples

Retrieve client credentials samples-retrieve-client-credentials

Request
code language-https 
POST /o/client/register HTTP/1.1

    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Content-Type: application/json
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

{
    "software_statement": "eyJhbGciOiJSUzI1NiJ9.
        eyJzb2Z0d2FyZV9pZCI6IjROUkIxLTBYWkFCWkk5RTYtNVNNM1IiLCJjbGll
        bnRfbmFtZSI6IkV4YW1wbGUgU3RhdGVtZW50LWJhc2VkIENsaWVudCIsImNs
        aWVudF91cmkiOiJodHRwczovL2NsaWVudC5leGFtcGxlLm5ldC8ifQ.
        GHfL4QNIrQwL18BSRdE595T9jbzqa06R9BT8w409x9oIcKaZo_mt15riEXHa
        zdISUvDIZhtiyNrSHQ8K4TvqWxH6uJgcmoodZdPwmWRIEYbQDLqPNxREtYn0
        5X3AR7ia4FRjQ2ojZjk5fJqJdQ-JcfxyhK-P8BAWBd6I2LLA77IG32xtbhxY
        fHX7VhuU5ProJO8uvu3Ayv4XRhLZJY4yKfmyjiiKiPNe-Ia4SMy_d_QSWxsk
        U5XIQl5Sa2YRPMbDRXttm2TfnZM1xx70DoYi8g6czz-CPGRi4SW_S2RKHIJf
        IjoI3zTJ0Y2oe0_EJAiXbL6OyF9S5tKxDXV8JIndSA",
    "redirect_uri": "adobepass://com.programmer"
 }
Response - Success
code language-https 
HTTP/1.1 201 Created

Content-Type: application/json;charset=UTF-8

{
    "client_id": "s6BhdRkqt3",
    "client_secret": "t7AkePiru4",
    "redirect_uris": [
        "app://com.programmer.adobe#sdasdsadas"
    ],
    "grant_types": [
        "client_credentials"
    ],
    "scopes": [
        "api:client:v2"
    ],
    "client_id_issued_at": 1723227212
}
Response - Error
code language-https 
HTTP/1.1 400 Bad Request

Content-Type: application/json;charset=UTF-8

{ "error": "invalid_request" }
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b