platform.startPlatformProviderAuthorization

POST

/v1/platform/model_providers/{providerId}/oauth/authorizations

const url = 'https://example.com/v1/platform/model_providers/example/oauth/authorizations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"redirectUri":"example","expectedVersion":1}'
};

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

curl --request POST \
  --url https://example.com/v1/platform/model_providers/example/oauth/authorizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "redirectUri": "example", "expectedVersion": 1 }'

Authorizations

token
session

Parameters

Path Parameters

providerId

required

string

Request Body^required

application/json

object

redirectUri

required

string

>= 1 characters <= 4096 characters

expectedVersion

required

integer

<= 9007199254740991

Example ^generated

{
  "redirectUri": "example",
  "expectedVersion": 1
}

Responses

200

Success

application/json

object

required

string

>= 1 characters

url

required

string

expiresAt

required

string

Example ^generated

{
  "id": "example",
  "url": "example",
  "expiresAt": "example"
}

400

ModelProviderAuthorizationInvalid | ModelProviderInvalid

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ModelProviderAuthorizationInvalid

message

required

string

Example

{
  "_tag": "ModelProviderAuthorizationInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

ModelProviderNotFound | ModelNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ModelProviderNotFound

providerId

required

string

Example

{
  "_tag": "ModelProviderNotFound"
}

409

application/json

Any of:

object

_tag

required

string

Allowed values: ModelProviderLoginRequired

Example

{
  "_tag": "ModelProviderLoginRequired"
}

503

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}

platform.startPlatformProviderAuthorization

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

503

Example

Request Body^required

Example ^generated

Example ^generated