Team Groups Management Service

Create Team Group

Creates a new team group.

post/aaa/team-groups/v2

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2
  • Auth: API key in header Authorization

Request body

descriptionstring

Human-readable description of the team group.

externalIdstring

External identifier for the group, used when the group is managed by an external identity provider.

groupType'GROUP_TYPE_UNSPECIFIED' | 'GROUP_TYPE_OPEN' | 'GROUP_TYPE_CLOSED' | 'GROUP_TYPE_RESTRICTED'

Group type.

namestring

Unique display name for the new team group.

roleIdinteger

Identifier of the role to assign to this group.

roleNamestring

Name of the role to assign to this group, as an alternative to roleId. Resolved against this team's custom roles and the global built-in roles. Matching is case-insensitive. The response reports the resolved role's id and canonical name. Mutually exclusive with roleId: setting both is rejected.

teamIdinteger

Team to associate the group with. If not set, uses the authenticated team.

userIdsstring[]

The user ids.

Response

Changes

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