Add API Key

POST 
/workspaces/:workspaceId/service-accounts/:subjectId/api-keys

Add API Key

Request

Path Parameters

workspaceId uuidrequired
subjectId uuidrequired

application/json

Body

displayName string
expiresAt date-timenullable

text/json

Body

displayName string
expiresAt date-timenullable

application/*+json

Body

displayName string
expiresAt date-timenullable

Responses

201

API key added.

application/json

Schema

Schema

apiKeyId uuid
displayName string
expiresAt date-timenullable
creatorSubjectId uuidnullable
publicPrefix string
createdAt date-time

Example (from schema)

{
  "apiKeyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "displayName": "string",
  "expiresAt": "2024-11-22T11:58:28.957Z",
  "creatorSubjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "publicPrefix": "string",
  "createdAt": "2024-11-22T11:58:28.957Z"
}

400

Invalid request.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Workspace or service account not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace is disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...