{ "components": { "schemas": { "MediaTokenResponse": { "type": "object", "properties": { "notAfter": { "format": "int64", "type": "integer" }, "serializedToken": { "type": "string" }, "notBefore": { "format": "int64", "type": "integer" } } }, "OperatingSystem": { "type": "object", "properties": { "vendor": { "type": "string" }, "name": { "type": "string" }, "family": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" } } }, "ConfigurationResponse": { "type": "object", "properties": { "platformCategory": { "type": "string" }, "os": { "type": "string" }, "sdkType": { "type": "string" }, "platform": { "type": "string" }, "requestor": { "$ref": "#/components/schemas/ProgrammerType" } } }, "Message": { "type": "object" }, "createPartnerProfileUsingPOST_1_request": { "type": "object", "properties": { "SAMLResponse": { "description": "The partner authentication response that contains the needed user metadata to create and save a partner profile.\n\nThe value must be Base64-encoded and afterward URL-encoded.", "type": "string" } }, "required": [ "SAMLResponse" ] }, "ErrorInformation": { "type": "object", "properties": { "trace": { "type": "string" }, "code": { "type": "string" }, "action": { "type": "string" }, "helpUrl": { "type": "string" }, "details": { "type": "string" }, "message": { "$ref": "#/components/schemas/Message" }, "status": { "format": "int32", "type": "integer" } } }, "ProgrammerType": { "type": "object", "properties": { "mvpds": { "type": "array", "items": { "$ref": "#/components/schemas/MvpdType" } }, "channels": { "type": "string" }, "name": { "type": "string" }, "domains": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } }, "id": { "type": "string" } } }, "Version": { "type": "object", "properties": { "patch": { "format": "int32", "type": "integer" }, "major": { "format": "int32", "type": "integer" }, "minor": { "format": "int32", "type": "integer" }, "profile": { "type": "string" } } }, "Hardware": { "type": "object", "properties": { "vendor": { "type": "string" }, "name": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" }, "manufacturer": { "type": "string" } } }, "MvpdProfileResponse": { "description": "Mvpd profile response", "type": "object", "properties": { "notAfter": { "format": "int64", "description": "The maximum timestamp for the authentication profile time-to-live (ttl).", "type": "integer" }, "attributes": { "description": "The list of user metadata attributes. These attributes can be mandatory (userId) or non-mandatory (the rest of the user metadata fields like zip, householdId, maxRating, etc.).", "additionalProperties": { "$ref": "#/components/schemas/UserMetadataResponse" }, "type": "object" }, "type": { "description": "The type of the authenticated profile.", "type": "string" }, "issuer": { "description": "The entity that owns the authenticated profile.", "type": "string" }, "notBefore": { "format": "int64", "description": "The minimum timestamp for the authentication profile time-to-live (ttl).", "type": "integer" } } }, "ProfilesResponse": { "type": "object", "properties": { "profiles": { "additionalProperties": { "$ref": "#/components/schemas/MvpdProfileResponse" }, "type": "object" } } }, "DecisionResponse": { "description": "Response object for decision requests", "type": "object", "properties": { "notAfter": { "format": "int64", "type": "integer" }, "resource": { "description": "The resource identifier for which the authorize decision is returned.", "type": "string" }, "authorized": { "description": "The authorization decision for the resource. Can be either true or false.", "type": "boolean", "example": false }, "serviceProvider": { "description": "The internal unique identifier associated with a Service Provider during on-boarding process.", "type": "string" }, "source": { "description": "Information about decision source: degradation, temppass, mvpd or dummy.", "type": "string" }, "error": { "$ref": "#/components/schemas/ErrorInformation" }, "mvpd": { "description": "The internal unique identifier associated with an Identity Provider during on-boarding process.", "type": "string" }, "notBefore": { "format": "int64", "type": "integer" }, "token": { "$ref": "#/components/schemas/MediaTokenResponse" } } }, "LogoutResponse": { "type": "object", "properties": { "logouts": { "additionalProperties": { "$ref": "#/components/schemas/MvpdLogoutResponse" }, "type": "object" } } }, "DecisionsResponse": { "type": "object", "properties": { "decisions": { "type": "array", "items": { "$ref": "#/components/schemas/DecisionResponse" } } } }, "Device": { "type": "object", "properties": { "browser": { "$ref": "#/components/schemas/Browser" }, "display": { "$ref": "#/components/schemas/Display" }, "connection": { "$ref": "#/components/schemas/Connection" }, "model": { "type": "string" }, "applicationId": { "type": "string" }, "type": { "type": "string", "enum": [ "Camera", "DataCollectionTerminal", "Desktop", "EmbeddedNetworkModule", "eReader", "GamesConsole", "GeolocationTracker", "Glasses", "MediaPlayer", "MobilePhone", "PaymentTerminal", "PluginModem", "SetTopBox", "TV", "Tablet", "WirelessHotspot", "Wristwatch", "VehicleMultimediaSystem", "Projector", "Unknown" ] }, "operatingSystem": { "$ref": "#/components/schemas/OperatingSystem" }, "version": { "$ref": "#/components/schemas/Version" }, "hardware": { "$ref": "#/components/schemas/Hardware" } } }, "SessionStatusResponse": { "description": "Response object for session status requests", "type": "object", "properties": { "notAfter": { "description": "The timestamp after which the authentication code is not valid.", "type": "string" }, "existingParameters": { "description": "The existing parameters that were already provided.", "additionalProperties": { "type": "string" }, "type": "object" }, "missingParameters": { "description": "The existing parameters that were already provided.", "type": "array", "items": { "type": "string" } }, "device": { "$ref": "#/components/schemas/Device" }, "notBefore": { "description": "The timestamp before which the authentication code is not valid.", "type": "string" } } }, "Connection": { "type": "object", "properties": { "port": { "type": "string" }, "ipAddress": { "$ref": "#/components/schemas/InetAddress" }, "secure": { "type": "boolean" }, "type": { "type": "string" } } }, "MvpdLogoutResponse": { "description": "Mvpd logout response", "type": "object", "properties": { "actionType": { "description": "The type of interaction the client application must perform in order to continue the flow with the action specified by the parameter \"actionName\".", "type": "string" }, "mvpd": { "description": "The internal unique identifier associated with an Identity Provider during on-boarding process.", "type": "string" }, "url": { "description": "The logout URL used to perform logout flow with the MVPD endpoint. It is not present when: actionName=complete or actionName=invalid.", "type": "string" }, "actionName": { "description": "The action to be performed in a user-agent.", "type": "string" } } }, "MvpdType": { "type": "object", "properties": { "displayInPlatformPicker": { "type": "boolean" }, "displayName": { "type": "string" }, "platformMappingId": { "type": "string" }, "authPerBrowserSession": { "type": "boolean" }, "enablePlatformServices": { "type": "boolean" }, "isTempPass": { "type": "boolean" }, "isProxy": { "type": "boolean" }, "logoUrl": { "type": "string" }, "authPerAggregator": { "type": "boolean" }, "passiveAuthnEnabled": { "type": "boolean" }, "enforcePlatformPermissions": { "type": "boolean" }, "boardingStatus": { "type": "string" }, "id": { "type": "string" } } }, "retrieveVerificationTokenUsingPOST_1_request": { "type": "object", "properties": { "redirectUrl": { "description": "The final redirect URL to which the user agent navigates when the authentication flow for the MVPD is completed.\n\nThe value must be URL-encoded.\n\nIf the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.", "type": "string" }, "domainName": { "description": "The originating domain of the application performing MVPD login.\n\nIf the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.", "type": "string" } }, "required": [ "domainName", "redirectUrl" ] }, "createSessionUsingPOST_1_request": { "type": "object", "properties": { "redirectUrl": { "description": "The final redirect URL to which the user agent navigates when the authentication flow for the MVPD is completed.\n\nThe value must be URL-encoded.\n\nIf the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.", "type": "string" }, "domainName": { "description": "The originating domain of the application performing MVPD login.\n\nIf the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.", "type": "string" }, "mvpd": { "description": "The internal unique identifier associated with the Identity Provider during onboarding process.\n\nIf the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.", "type": "string" } } }, "UserMetadataResponse": { "type": "object", "properties": { "state": { "type": "string" }, "error": { "type": "string", "enum": [ "invalid_parameter_service_provider", "invalid_parameter_mvpd", "invalid_parameter_code", "invalid_parameter_redirect_url", "invalid_parameter_resources", "invalid_parameter_partner", "invalid_parameter_saml_response", "invalid_header_device_info", "invalid_header_device_identifier", "invalid_header_identity_for_temporary_access", "invalid_header_pfs_permission_access_not_present", "invalid_header_pfs_permission_access_not_determined", "invalid_header_pfs_permission_access_not_granted", "invalid_header_pfs_provider_id_not_determined", "invalid_header_pfs_provider_id_mismatch", "invalid_header_pfs_provider_info_expired", "invalid_integration", "invalid_authentication_session", "authorization_denied_by_degradation_rule", "authorization_denied_by_degradation_configuration_change", "internal_server_error", "invalid_refresh_token", "preauthorization_denied_by_mvpd", "authorization_denied_by_mvpd", "authorization_denied_by_parental_controls", "invalid_requestor", "invalid_device_info", "invalid_device_id", "missing_resource", "malformed_authz_request", "internal_error", "invalid_configuration_user_metadata_certificate", "invalid_configuration_temporary_access", "invalid_configuration_platform", "invalid_configuration_platform_id", "invalid_configuration_platform_trait", "invalid_configuration_platform_category_trait", "invalid_configuration_platform_services", "invalid_configuration_mvpd_platform", "invalid_configuration_mvpd_platform_boarding_status", "invalid_configuration_mvpd_platform_profile_exchange", "too_many_resources", "unknown_integration", "invalid_access_token_service_provider", "invalid_access_token_client_application", "authenticated_profile_missing", "authenticated_profile_expired", "authenticated_profile_invalidated", "temporary_access_duration_limit_exceeded", "temporary_access_resources_limit_exceeded", "authorization_denied_by_hba_policies", "authorization_denied_by_session_invalidated", "identity_not_recognized_by_mvpd", "authentication_session_issuer_mismatch", "authentication_session_invalidated", "authentication_session_missing", "authentication_session_expired", "preauthorization_authentication_session_missing", "preauthorization_authentication_session_expired", "authorization_not_found", "authorization_expired", "network_received_error", "network_connection_timeout", "maximum_execution_time_exceeded", "degraded_integration" ] }, "value": { "type": "object", "properties": { } } } }, "Domain": { "type": "object", "properties": { "name": { "type": "string" }, "mvpdInitiated": { "type": "boolean" } } }, "SessionResponse": { "description": "Response object for session requests", "type": "object", "properties": { "actionType": { "description": "The type of interaction the client application must perform in order to continue the flow with the action specified by the parameter \"actionName\".", "type": "string" }, "notAfter": { "description": "The timestamp after which the authentication code is not valid.", "type": "string" }, "code": { "description": "The registration code that can be used on the secondary device to continue the authentication flow.", "type": "string" }, "serviceProvider": { "description": "The id of the service provider.", "type": "string" }, "missingParameters": { "description": "The missing parameters that need to be provided in order to complete the authentication flow.", "type": "array", "items": { "type": "string" } }, "sessionId": { "description": "The opaque identifier that can be used for tracking user activity.", "type": "string" }, "reasonType": { "description": "Details regarding the cause of the response.", "type": "string" }, "mvpd": { "description": "The id of the identity provider.", "type": "string" }, "notBefore": { "description": "The timestamp before which the authentication code is not valid.", "type": "string" }, "url": { "description": "The url where the application needs to navigate.", "type": "string" }, "actionName": { "description": "The action that primary device need to perform in order to complete authentication flow.", "type": "string" } } }, "InetAddress": { "type": "object", "properties": { "linkLocalAddress": { "type": "boolean" }, "hostName": { "type": "string" }, "loopbackAddress": { "type": "boolean" }, "mcsiteLocal": { "type": "boolean" }, "address": { "type": "array", "items": { "format": "byte", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" } }, "canonicalHostName": { "type": "string" }, "mcglobal": { "type": "boolean" }, "mcnodeLocal": { "type": "boolean" }, "siteLocalAddress": { "type": "boolean" }, "mclinkLocal": { "type": "boolean" }, "mcorgLocal": { "type": "boolean" }, "multicastAddress": { "type": "boolean" }, "hostAddress": { "type": "string" }, "anyLocalAddress": { "type": "boolean" } } }, "Browser": { "type": "object", "properties": { "originalUserAgent": { "type": "string" }, "vendor": { "type": "string" }, "name": { "type": "string" }, "userAgent": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" } } }, "Display": { "type": "object", "properties": { "vendor": { "type": "string" }, "name": { "type": "string" }, "ppi": { "format": "int64", "type": "integer" }, "width": { "format": "int64", "type": "integer" }, "diagonalSize": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" }, "height": { "format": "int64", "type": "integer" } } }, "retrieveAuthorizeDecisionsForMvpdUsingPOST_request": { "type": "object", "properties": { "resources": { "type": "array", "items": { "type": "string" } } } } } }, "servers": [ { "url": "https://sp.auth.adobe.com/api/v2" }, { "url": "https://sp-prequal.auth.adobe.com/api/v2" }, { "url": "https://sp-prequal.auth-staging.adobe.com/api/v2" }, { "url": "https://sp.auth-staging.adobe.com/api/v2" } ], "openapi": "3.0.1", "paths": { "/{serviceProvider}/decisions/authorize/{mvpd}": { "post": { "summary": "Retrieve authorization decisions using specific MVPD", "x-codegen-request-body-name": "body", "requestBody": { "description": "The list of resources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAuthorizeDecisionsForMvpdUsingPOST_request" } } }, "required": true }, "operationId": "retrieveAuthorizeDecisionsForMvpdUsingPOST", "responses": { "200": { "description": "OK. The response body contains a list of decisions with additional information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionsResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "mvpd", "description": "The internal unique identifier associated with the Identity Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Content-Type", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Adobe-Subject-Token", "description": "The generation of the single sign-on payload for the Platform Identity method is described in the [Adobe-Subject-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-adobe-subject-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a platform identity, refer to the [Single sign-on using platform identity flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AD-Service-Token", "description": "The generation of the single sign-on payload for the Service Token method is described in the [AD-Service-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ad-service-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a service token, refer to the [Single sign-on using service token flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Partner-Framework-Status", "description": "The generation of the single sign-on payload for the Partner method is described in the [AP-Partner-Framework-Status](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-partner-framework-status.html) documentation.\n\nFor more details about single sign-on enabled flows using a partner, refer to the [Single sign-on using partner flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Temppass-Identity", "description": "The generation of the user unique identifier payload is described in the [AP-TempPass-Identity](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-temppass-identity.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "4. Decisions" ] } }, "/{serviceProvider}/logout/{mvpd}": { "get": { "summary": "Initiate logout for specific MVPD", "operationId": "getLogoutForMvpdUsingGET", "responses": { "200": { "description": "OK. The response body contains a list of actions the client must perform in order to complete the logout flow for each deleted profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "302": { "description": "Found. The response body contains a location redirect to continue the flow until reaching the MVPD login page", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "mvpd", "description": "The internal unique identifier associated with the Identity Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "redirectUrl", "description": "The final redirect URL to which the user agent navigates when the logout flow for the MVPD is completed.\n\nThe value must be URL-encoded." }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Adobe-Subject-Token", "description": "The generation of the single sign-on payload for the Platform Identity method is described in the [Adobe-Subject-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-adobe-subject-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a platform identity, refer to the [Single sign-on using platform identity flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AD-Service-Token", "description": "The generation of the single sign-on payload for the Service Token method is described in the [AD-Service-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ad-service-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a service token, refer to the [Single sign-on using service token flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "5. Logout" ] } }, "/{serviceProvider}/profiles/code/{code}": { "get": { "summary": "Retrieve profiles for specific code", "operationId": "getProfileForCodeUsingGET_1", "responses": { "200": { "description": "OK. The response body contains a map of valid profiles, which may be empty.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "code", "description": "The authentication code obtained after creating the authentication session on the streaming device.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "3. Profiles" ] } }, "/authenticate/{serviceProvider}/{code}": { "get": { "summary": "Perform authentication in user agent", "operationId": "startAuthenticationUsingGET_1", "responses": { "200": { "description": "OK", "content": { } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "302": { "description": "Found. The response body contains a location redirect to continue the flow until reaching the MVPD login page", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "code", "description": "The authentication code obtained after creating the authentication session on the streaming device.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "2. Sessions" ] } }, "/{serviceProvider}/configuration": { "get": { "summary": "Retrieve configuration for specific service provider", "operationId": "handleRequestUsingGET", "responses": { "200": { "description": "OK. The response body contains a list of MVPDs having an active integration with the 'serviceProvider'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "profile", "description": "-" }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "1. Configuration" ] } }, "/{serviceProvider}/profiles": { "get": { "summary": "Retrieve profiles", "operationId": "getProfilesUsingGET", "responses": { "200": { "description": "OK. The response body contains a map of valid profiles, which may be empty.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Adobe-Subject-Token", "description": "The generation of the single sign-on payload for the Platform Identity method is described in the [Adobe-Subject-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-adobe-subject-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a platform identity, refer to the [Single sign-on using platform identity flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AD-Service-Token", "description": "The generation of the single sign-on payload for the Service Token method is described in the [AD-Service-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ad-service-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a service token, refer to the [Single sign-on using service token flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Partner-Framework-Status", "description": "The generation of the single sign-on payload for the Partner method is described in the [AP-Partner-Framework-Status](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-partner-framework-status.html) documentation.\n\nFor more details about single sign-on enabled flows using a partner, refer to the [Single sign-on using partner flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "3. Profiles" ] } }, "/{serviceProvider}/profiles/sso/{partner}": { "post": { "summary": "Retrieve profile using partner authentication response", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/createPartnerProfileUsingPOST_1_request" } } }, "required": true }, "operationId": "createPartnerProfileUsingPOST_1", "responses": { "200": { "description": "OK. The response body contains a map of valid profiles, which may be empty.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "partner", "description": "The name of the partner (e.g., Apple) that provides the single sign-on framework integrated with Adobe Pass Authentication flows.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Content-Type", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/x-www-form-urlencoded.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Partner-Framework-Status", "description": "The generation of the single sign-on payload for the Partner method is described in the [AP-Partner-Framework-Status](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-partner-framework-status.html) documentation.\n\nFor more details about single sign-on enabled flows using a partner, refer to the [Single sign-on using partner flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "6. Partner Single Sign-On" ] } }, "/{serviceProvider}/sessions/sso/{partner}": { "post": { "summary": "Retrieve partner authentication request", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/retrieveVerificationTokenUsingPOST_1_request" } } }, "required": true }, "operationId": "retrieveVerificationTokenUsingPOST_1", "responses": { "200": { "description": "OK. The response body contains information about the next actions to perform authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "partner", "description": "The name of the partner (e.g., Apple) that provides the single sign-on framework integrated with Adobe Pass Authentication flows.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Content-Type", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/x-www-form-urlencoded.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Partner-Framework-Status", "description": "The generation of the single sign-on payload for the Partner method is described in the [AP-Partner-Framework-Status](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-partner-framework-status.html) documentation.\n\nFor more details about single sign-on enabled flows using a partner, refer to the [Single sign-on using partner flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "6. Partner Single Sign-On" ] } }, "/{serviceProvider}/sessions": { "post": { "summary": "Create authentication session", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/createSessionUsingPOST_1_request" } } } }, "operationId": "createSessionUsingPOST_1", "responses": { "200": { "description": "OK. The response body contains information about the next actions to perform authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Content-Type", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/x-www-form-urlencoded.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Adobe-Subject-Token", "description": "The generation of the single sign-on payload for the Platform Identity method is described in the [Adobe-Subject-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-adobe-subject-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a platform identity, refer to the [Single sign-on using platform identity flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AD-Service-Token", "description": "The generation of the single sign-on payload for the Service Token method is described in the [AD-Service-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ad-service-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a service token, refer to the [Single sign-on using service token flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "2. Sessions" ] } }, "/{serviceProvider}/decisions/preauthorize/{mvpd}": { "post": { "summary": "Retrieve preauthorization decisions using specific MVPD", "x-codegen-request-body-name": "body", "requestBody": { "description": "The list of resources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAuthorizeDecisionsForMvpdUsingPOST_request" } } }, "required": true }, "operationId": "retrievePreAuthorizeDecisionsForMvpdUsingPOST_1", "responses": { "200": { "description": "OK. The response body contains a list of decisions with additional information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionsResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "mvpd", "description": "The internal unique identifier associated with the Identity Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Content-Type", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Adobe-Subject-Token", "description": "The generation of the single sign-on payload for the Platform Identity method is described in the [Adobe-Subject-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-adobe-subject-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a platform identity, refer to the [Single sign-on using platform identity flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AD-Service-Token", "description": "The generation of the single sign-on payload for the Service Token method is described in the [AD-Service-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ad-service-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a service token, refer to the [Single sign-on using service token flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Partner-Framework-Status", "description": "The generation of the single sign-on payload for the Partner method is described in the [AP-Partner-Framework-Status](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-partner-framework-status.html) documentation.\n\nFor more details about single sign-on enabled flows using a partner, refer to the [Single sign-on using partner flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Temppass-Identity", "description": "The generation of the user unique identifier payload is described in the [AP-TempPass-Identity](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-temppass-identity.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "4. Decisions" ] } }, "/{serviceProvider}/sessions/{code}": { "post": { "summary": "Resume authentication session", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/createSessionUsingPOST_1_request" } } } }, "operationId": "resumeSessionUsingPOST", "responses": { "200": { "description": "OK. The response body contains information about the next actions to perform authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "code", "description": "The authentication code obtained after creating the authentication session on the streaming device.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Content-Type", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/x-www-form-urlencoded.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "2. Sessions" ] }, "get": { "summary": "Retrieve authentication session using code", "operationId": "getSessionStatusUsingGET", "responses": { "200": { "description": "OK. The response body contains information about the authentication session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionStatusResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "code", "description": "The authentication code obtained after creating the authentication session on the streaming device.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "2. Sessions" ] } }, "/{serviceProvider}/profiles/{mvpd}": { "get": { "summary": "Retrieve profiles for specific MVPD", "operationId": "getProfileForMvpdUsingGET_1", "responses": { "200": { "description": "OK. The response body contains a map of valid profiles, which may be empty.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesResponse" } } } }, "400": { "description": "Bad request. The request is invalid, the client needs to correct the request and try again. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "401": { "description": "Unauthorized. The access token is invalid, the client needs to obtain a new access token and try again. For more details refer to the [Dynamic Client Registration](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-dcr/dynamic-client-registration-overview.html) documentation.", "content": { } }, "500": { "description": "Internal Server Error. The server side encountered an issue. The response body may contain error information that adheres to the [Enhanced Error Codes](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/standard-features/error-reporting/enhanced-error-codes.html) documentation.", "content": { } }, "405": { "description": "Method not allowed. The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.", "content": { } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "mvpd", "description": "The internal unique identifier associated with the Identity Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "serviceProvider", "description": "The internal unique identifier associated with the Service Provider during onboarding process.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "The generation of the bearer token payload is described in the [Authorization](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-authorization.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Device-Identifier", "description": "The generation of the device identifier payload is described in the [AP-Device-Identifier](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-device-identifier.html) header documentation.", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "X-Device-Info", "description": "The generation of the device information payload is described in the [X-Device-Info](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-x-device-info.html) header documentation.\n\nIt is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.\n\nWhen provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).\n\nWhen not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "Adobe-Subject-Token", "description": "The generation of the single sign-on payload for the Platform Identity method is described in the [Adobe-Subject-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-adobe-subject-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a platform identity, refer to the [Single sign-on using platform identity flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AD-Service-Token", "description": "The generation of the single sign-on payload for the Service Token method is described in the [AD-Service-Token](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ad-service-token.html) documentation.\n\nFor more details about single sign-on enabled flows using a service token, refer to the [Single sign-on using service token flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Partner-Framework-Status", "description": "The generation of the single sign-on payload for the Partner method is described in the [AP-Partner-Framework-Status](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-partner-framework-status.html) documentation.\n\nFor more details about single sign-on enabled flows using a partner, refer to the [Single sign-on using partner flows](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-flows/rest-api-v2-single-sign-on-access-flows/rest-api-v2-single-sign-on-service-token-flows.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "AP-Temppass-Identity", "description": "The generation of the user unique identifier payload is described in the [AP-TempPass-Identity](https://experienceleague.adobe.com/docs/pass/authentication/integration-guide-programmers/rest-apis/rest-api-v2/rest-api-v2-appendix/rest-api-v2-appendix-headers/rest-api-v2-appendix-headers-ap-temppass-identity.html) documentation." }, { "schema": { "type": "string" }, "in": "header", "name": "Accept", "description": "The media type accepted by the client application.\n\nIf specified, it must be application/json." }, { "schema": { "type": "string" }, "in": "header", "name": "User-Agent", "description": "The user agent of the client application." } ], "tags": [ "3. Profiles" ] } } }, "x-original-swagger-version": "2.0", "info": { "title": "REST API", "version": "V2" }, "tags": [ { "name": "2. Sessions", "description": "Create authentication sessions" }, { "name": "6. Partner Single Sign-On", "description": "Handle partner authentication" }, { "name": "5. Logout", "description": "Delete authenticated profiles" }, { "name": "3. Profiles", "description": "Obtain information about authenticated profiles" }, { "name": "1. Configuration", "description": "Retrieve the configuration associated with the Service Provider" }, { "name": "4. Decisions", "description": "Obtain informative/authoritative decisions" } ] }