Skip to content
Workshape Catalyst Operator Docs

API Access

Revoke an API key

Section titled “Revoke an API key”

POST /api/v1/instance/api-credentials/{credentialId}/revoke

Operation
api_credentials.revoke
Accepts
sessionCookie, sessionToken
Scope
api_access:write
Rights
api_access.manage
Effect
changing
Rate class
write

Parameters

  • credentialId string in path, required

Answers

  • 200 The result

    application/json: ApiCredential

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List service principals with their credentials

Section titled “List service principals with their credentials”

GET /api/v1/instance/service-principals

Operation
service_principals.list
Accepts
sessionCookie, sessionToken
Scope
api_access:read
Rights
api_access.manage
Effect
reading
Rate class
read

Parameters

  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Create a service principal

Section titled “Create a service principal”

POST /api/v1/instance/service-principals

Operation
service_principals.create
Accepts
sessionCookie, sessionToken
Scope
api_access:write
Rights
api_access.manage
Effect
changing
Rate class
write

Request body

application/json: CreateServicePrincipalRequest

Answers

  • 200 The result

    application/json: ServicePrincipalDetail

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Change a service principal

Section titled “Change a service principal”

PATCH /api/v1/instance/service-principals/{servicePrincipalId}

Operation
service_principals.update
Accepts
sessionCookie, sessionToken
Scope
api_access:write
Rights
api_access.manage
Effect
changing
Rate class
write

Parameters

  • servicePrincipalId string in path, required

Request body

application/json: UpdateServicePrincipalRequest

Answers

  • 200 The result

    application/json: ServicePrincipalDetail

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Issue an API key for a service principal

Section titled “Issue an API key for a service principal”

POST /api/v1/instance/service-principals/{servicePrincipalId}/credentials

Operation
api_credentials.create
Accepts
sessionCookie, sessionToken
Scope
api_access:write
Rights
api_access.manage
Effect
changing
Rate class
write

Parameters

  • servicePrincipalId string in path, required

Request body

application/json: CreateApiCredentialRequest

Answers

  • 200 The result

    application/json: CreateApiCredentialResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.