2. Sessions

Create authentication session

Changed on
post/{serviceProvider}/sessions

Request

  • Base URL: https://sp.auth.adobe.com/api/v2
  • URL: https://sp.auth.adobe.com/api/v2/{serviceProvider}/sessions
  • Auth: none declared. Required headers: Authorization, Content-Type, AP-Device-Identifier, X-Device-Info

Path parameters

serviceProviderstring required

The internal unique identifier associated with the Service Provider during onboarding process.

Headers

Authorizationstring required

The generation of the bearer token payload is described in the Authorization header documentation.

Content-Typestring required

The media type accepted by the client application.

If specified, it must be application/x-www-form-urlencoded.

AP-Device-Identifierstring required

The generation of the device identifier payload is described in the AP-Device-Identifier header documentation.

X-Device-Infostring required

The generation of the device information payload is described in the X-Device-Info header 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).

Adobe-Subject-Tokenstring

The generation of the single sign-on payload for the Platform Identity method is described in the Adobe-Subject-Token documentation.

For more details about single sign-on enabled flows using a platform identity, refer to the Single sign-on using platform identity flows documentation.

AD-Service-Tokenstring

The generation of the single sign-on payload for the Service Token method is described in the AD-Service-Token documentation.

For more details about single sign-on enabled flows using a service token, refer to the Single sign-on using service token flows documentation.

Acceptstring

The media type accepted by the client application.

If specified, it must be application/json.

User-Agentstring

The user agent of the client application.

AP-Visitor-Identifierstring

The Adobe Experience Cloud ID (ECID) that uniquely identifies a visitor across Adobe Experience Cloud solutions. The generation of the visitor identifier payload is described in the Using Experience Cloud ID in Adobe Pass Authentication documentation.

Response

OK. <summary>The response body contains information about the next actions to perform authentication.<summary>

actionTypestring required

The type of interaction the client application must perform in order to continue the flow with the action specified by the parameter "actionName".

notAfterstring

The timestamp after which the authentication code is not valid.

codestring

The registration code that can be used on the secondary device to continue the authentication flow.

serviceProviderstring required

The id of the service provider.

missingParametersstring[]

The missing parameters that need to be provided in order to complete the authentication flow.

sessionIdstring required

The opaque identifier that can be used for tracking user activity.

reasonTypestring required

Details regarding the cause of the response.

mvpdstring

The id of the identity provider.

notBeforestring

The timestamp before which the authentication code is not valid.

urlstring

The url where the application needs to navigate.

actionNamestring required

The action that primary device need to perform in order to complete authentication flow.

Changes

    • info

      api operation id createSessionUsingPOST_1 removed and replaced with createSessionUsingPOST

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the new optional header request parameter AP-Visitor-Identifier