TEtetrascience
Access Groups

Edit an Access Group

Edit an access group's name, description, status, and data access rules.

put/v1/accessGroups/{id}

Request

  • Base URL
    https://api.tetrascience.com
  • URL
    https://api.tetrascience.com/v1/accessGroups/{id}
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Path parameters

idstring uuid required

Request body

namestring required

The name of the group.

descriptionstring nullable

The description of the group.

enabledboolean required

Indicates whether the group is enabled or not.

rulesAttributeRuleConfiguration required
ssoGroupMappingsstring[]

Response

The updated access group.

idstring uuid required

The unique identifier of the group.

namestring required

The name of the group.

descriptionstring nullable

The description of the group.

orgSlugstring required

The organization's slug to which the group belongs.

enabledboolean required

Indicates whether the group is enabled or not.

userIdsstring[] nullable

List of user IDs associated with the group.

rulesAttributeRuleConfiguration required
updatedAtstring date-time nullable
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.