appAuthorization.getAppAuthorization

GET

/v1/app-authorizations/{flowId}

const url = 'https://example.com/v1/app-authorizations/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/app-authorizations/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

flowId

required

string

>= 1 characters

Responses

200

Success

application/json

object

flowId

required

string

>= 1 characters

connectionId

required

string

>= 1 characters <= 128 characters

executionId

required

Any of:

string
null

string

>= 1 characters <= 128 characters

returnTo

required

string

<= 4096 characters

expiresAt

required

number

issuer

required

string

resource

required

string

scopes

required

Array<string>

status

required

string

Allowed values: Waiting Received Processing Succeeded Cancelled Failed

reason

required

Any of:

string
null

string

Example

{
  "status": "Waiting"
}

400

ExperienceInputInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ExperienceNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

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

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

422

AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed

application/json

Any of:

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

Example

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

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}