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" }'

Authorizations

• token
• session

Parameters

Path Parameters

connectionId

required

string

>= 1 characters

Request Body^required

Media typeapplication/json

object

revision

required

integer

<= 9007199254740991

scopes

required

Array<string>

<= 50 items

issuer

string

returnTo

string

<= 4096 characters

Example ^generated

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

Responses

200

Success

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AuthorizationStarted

flowId

required

string

>= 1 characters

authorizationUrl

required

string

issuer

required

string

scopes

required

Array<string>

object

object

_tag

required

string

Allowed values: IssuerSelectionRequired

issuers

required

Array<string>

>= 1 items

scopes

required

Array<string>

object

object

_tag

required

string

Allowed values: AuthorizationNotRequired

Example

{
  "_tag": "AuthorizationStarted"
}

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

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

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: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "AppRestricted"
}

404

ExperienceNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: ExperienceNotFound

id

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

ConnectionCleanupPending | ConnectionConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ConnectionCleanupPending

connectionId

required

string

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

Example

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

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"
}

503

AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppAuthorizationUnavailable

object

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "AppAuthorizationUnavailable"
}