Skip to content
Workshape Catalyst Operator Docs

Users

List the users of the instance

Section titled “List the users of the instance”

GET /api/v1/instance/users

Operation
users.list
Accepts
sessionCookie, sessionToken
Scope
user_admin:read
Rights
users.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 user

Section titled “Create a user”

POST /api/v1/instance/users

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

Request body

application/json: CreateAdministeredUserRequest

Answers

  • 200 The result

    application/json: AdministeredUser

  • 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.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 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 user’s profile, roles or status

Section titled “Change a user’s profile, roles or status”

PATCH /api/v1/instance/users/{userId}

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

Parameters

  • userId string in path, required

Request body

application/json: UpdateAdministeredUserRequest

Answers

  • 200 The result

    application/json: AdministeredUser

  • 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.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 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.

Delete a user and their data. Answers 202 when the user is closed and their data is still being removed.

Section titled “Delete a user and their data. Answers 202 when the user is closed and their data is still being removed.”

DELETE /api/v1/instance/users/{userId}

Operation
users.delete
Accepts
sessionCookie, sessionToken
Scope
user_admin:write
Rights
users.manage
Effect
changing
Rate class
write

Parameters

  • userId string in path, required

Answers

  • 200 The result

    application/json: AdministeredUser

  • 202 The call was accepted and its work finishes by itself. The answer has no body.
  • 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.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 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.
Section titled “Link a sign-in identity to a user”

PUT /api/v1/instance/users/{userId}/identities

Operation
users.identities.upsert
Accepts
sessionCookie, sessionToken
Scope
user_admin:write
Rights
users.manage
Effect
changing
Rate class
write

Parameters

  • userId string in path, required

Request body

application/json: UpsertAdministeredUserIdentityRequest

Answers

  • 200 The result

    application/json: AdministeredUser

  • 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.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 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.
Section titled “Unlink a sign-in identity from a user”

DELETE /api/v1/instance/users/{userId}/identities/{authSource}/{externalUserId}

Operation
users.identities.delete
Accepts
sessionCookie, sessionToken
Scope
user_admin:write
Rights
users.manage
Effect
changing
Rate class
write

Parameters

  • userId string in path, required
  • authSource string in path, required
  • externalUserId string in path, required

Answers

  • 200 The result

    application/json: AdministeredUser

  • 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.
Section titled “Mail a user a link to set their password”

POST /api/v1/instance/users/{userId}/invitation

Operation
users.invitation.send
Accepts
sessionCookie, sessionToken
Scope
user_admin:write
Rights
users.manage
Effect
changing
Rate class
write

Parameters

  • userId string in path, required

Answers

  • 200 The result

    application/json: SendAdministeredUserInvitationResponse

  • 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.

Set a user’s password

Section titled “Set a user’s password”

POST /api/v1/instance/users/{userId}/password

Operation
users.password.reset
Accepts
sessionCookie, sessionToken
Scope
user_admin:write
Rights
users.manage
Effect
changing
Rate class
write

Parameters

  • userId string in path, required

Request body

application/json: ResetAdministeredUserPasswordRequest

Answers

  • 200 The result

    application/json: ResetAdministeredUserPasswordResponse

  • 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.