Skip to content
OpenBot

appAuthorization.completeAppAuthorization

POST
/v1/app-authorizations/{flowId}/complete
curl --request POST \
  --url https://example.com/v1/app-authorizations/example/complete \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
flowId
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
flowId
required
string
>= 1 characters
connectionId
required
string
>= 1 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

Example 

{
  "status": "Waiting"
}

400

Section titled “400”

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExperienceInputInvalid
message
required
string

Example 

{
  "_tag": "ExperienceInputInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppRestricted
restriction
required
object
cardUrl
required
string
reason
required
string
>= 1 characters
appealUrl
required
string

Example 

{
  "_tag": "AppRestricted"
}

404

Section titled “404”

ExperienceNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ExperienceNotFound
id
required
string

Example 

{
  "_tag": "ExperienceNotFound"
}

409

Section titled “409”

ConnectionCleanupPending | ConnectionConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ConnectionCleanupPending
connectionId
required
string
stage
required
string
Allowed values: Credentials Connection
message
required
string

Example 

{
  "_tag": "ConnectionCleanupPending",
  "stage": "Credentials"
}

422

Section titled “422”

AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed

Media typeapplication/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"
}

503

Section titled “503”

AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppAuthorizationUnavailable

Example 

{
  "_tag": "AppAuthorizationUnavailable"
}