Documentation Powered by ReDoc

Canonical Contract Service (1.0.0)

Download OpenAPI specification:Download

Manage Canonical contracts with customer accounts, access to Canonical products and services under those contracts.

Authentication

AdminBearerAuth

Authorization with administrator credentials

Security scheme type: HTTP
HTTP Authorization Scheme bearer

ContractTokenBearerAuth

Authorization with contract token.

Security scheme type: HTTP
HTTP Authorization Scheme bearer

MachineTokenBearerAuth

Authorization with machine token.

Security scheme type: HTTP
HTTP Authorization Scheme bearer

Create a contract

Create a contract

Authorizations:
AdminBearerAuth
Request Body schema: application/json
body
string

Contract body

Responses

200
post /v1/contract
/v1/contract

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "body": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "contractID": "string"
}

Get contract token

Get contract token

Authorizations:
AdminBearerAuth
Request Body schema: application/json
contractID
string

Contract ID

Responses

200
post /v1/contract-token
/v1/contract-token

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "contractID": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "contractToken": "string"
}

Get machine token

Get machine token

Authorizations:
ContractTokenBearerAuth
Request Body schema: application/json
machineID
string

Machine ID

Responses

200
post /v1/machine-token
/v1/machine-token

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "machineID": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "machineToken": "string"
}

Get service token

Get service token

Authorizations:
MachineTokenBearerAuth
Request Body schema: application/json
service
string

Responses

200
post /v1/service-token
/v1/service-token

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "service": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "serviceToken": "string"
}