Groups

Create group

Changed on
post/v2/workspaces/{workspace_id}/groups

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v2/workspaces/{workspace_id}/groups
  • Auth: HTTP bearer

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request body

namestring required

The group's name. Must be unique within the workspace.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'creator' | 'member' | 'installation' | 'provisioning'
role_idstring uuid nullable

Id of a custom role to grant instead of a builtin role.

Response

Successful Response

group_idstring uuid required

The group's unique identifier.

namestring required

The group's name.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'creator' | 'member' | 'installation' | 'provisioning'
role_idstring uuid nullable

Id of the role actually assigned. A custom role reports its own id here while role reports the builtin floor it grants, so read this to tell the two apart.

Changes

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • be9b0da71546Revision changes
    • warning

      added the new creator enum value to the / response property for the response status

    • info

      added the new creator enum value to the request property /