appAuthorization.beginAppAuthorization

POST

/v1/connections/{connectionId}/authorization

curl --request POST \
  --url https://example.com/v1/connections/example/authorization \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "revision": 1, "scopes": [ "example" ], "issuer": "example", "returnTo": "example", "commandKey": "example" }'

Authorizations

• token
• session

Parameters

Path Parameters

connectionId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

revision

required

integer

<= 9007199254740991

scopes

required

Array<string>

<= 50 items

issuer

string

returnTo

string

<= 4096 characters

commandKey

required

string

>= 1 characters <= 128 characters

Example ^generated

{
  "revision": 1,
  "scopes": [
    "example"
  ],
  "issuer": "example",
  "returnTo": "example",
  "commandKey": "example"
}

Responses

202

Success

Media typeapplication/json

object

executionId

required

string

>= 1 characters <= 128 characters

commandKey

required

string

>= 1 characters <= 128 characters

sequence

required

integer

<= 9007199254740991

Example ^generated

{
  "executionId": "example",
  "commandKey": "example",
  "sequence": 1
}

400

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionForbidden

object

object

_tag

required

string

Allowed values: AppRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ExperienceNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExperienceNotFound

id

required

string

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

object

object

_tag

required

string

Allowed values: ConnectionCleanupPending

connectionId

required

string

>= 1 characters <= 128 characters

stage

required

string

Allowed values: Credentials Connection

message

required

string

object

object

_tag

required

string

Allowed values: ConnectionConflict

reason

required

string

Allowed values: CandidateChanged RevisionChanged DraftExpired AlreadyAdded LimitReached

message

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ExecutionConflict"
}

422

AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppDiscoveryFailed

reason

required

string

Allowed values: InvalidInput IncompatibleCard NoDeclaration NoUsableServices Document Http BlockedTarget Transport TooLarge Timeout Redirect Encoding

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

object

object

_tag

required

string

Allowed values: ConnectionConfigurationInvalid

message

required

string

keys

required

Array<string>

object

object

_tag

required

string

Allowed values: AppAuthorizationFailed

reason

required

string

message

required

string

Example

{
  "_tag": "AppDiscoveryFailed",
  "reason": "InvalidInput"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: AppAuthorizationUnavailable

object

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}