Update organization API token

PATCH 
/api_tokens/api_token

Updates an organization API token with new properties

Scopes

• api_tokens

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

application/json

Body

api_token

object

required

All 'api_token[]' params are mutually exclusive, only one can be provided.

id string

properties

object

required

name string

authorized_ip_addresses string[]

expires_at integer

scopes string[]

annotations

object[]

Array [

key stringrequired

value string

]

Responses

200

Updates an organization API token with new properties

application/json

Schema

Schema

api_token

object

required

id string

name string

organization_id stringnullable

authorized_ip_addresses string[]

expires_at integernullable

rate_limit integer

scopes string[]

secret stringnullable

The secret will only be returned on token creation or when a new secret is generated.

annotations

object[]

required

Annotations for this API token

Array [

key stringrequired

value string

]

Example (from schema)

{
  "api_token": {
    "id": "string",
    "name": "string",
    "organization_id": "string",
    "authorized_ip_addresses": [
      "string"
    ],
    "expires_at": 0,
    "rate_limit": 0,
    "scopes": [
      "string"
    ],
    "secret": "string"
  },
  "annotations": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

No API token was found matching any of the criteria provided in the arguments.

application/json

Schema

Schema

code APITokenNotFoundEnum (string)

Possible values: [api_token_not_found]

description string
detail object

Example (from schema)

{
  "code": "api_token_not_found",
  "description": "string",
  "detail": {}
}

422

A validation error occurred with the object that was being created/updated/deleted

application/json

Schema

Schema

code ValidationErrorEnum (string)

Possible values: [validation_error]

description string

detail

ValidationError

errors string[]

Example (from schema)

{
  "code": "validation_error",
  "description": "string",
  "detail": {
    "errors": [
      "string"
    ]
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...