Skip to main content
Theme
Home

Create Team Group

POSThttps://api.coralogix.com/mgmt/openapi/5/aaa/team-groups/v2

Creates a new team group.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Body

application/json

Request to create a new team group with specified name, description, roles, users, and optional scope filters. Can be associated with a specific team or the authenticated team.

    description#string

    Human-readable description of the team group.

    externalId#string

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

    groupType#GroupType

    Group type.

    Possible values: [GROUP_TYPE_UNSPECIFIED, GROUP_TYPE_OPEN, GROUP_TYPE_CLOSED, GROUP_TYPE_RESTRICTED]

    name#string

    Unique display name for the new team group.

    roleId#int64

    Identifier of the role to assign to this group.

    Possible values: >= 0

    roleName#string

    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.

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[\s\S]*$

    Scope assignment for a group. References an existing scope by ID. Scopes can be created via the Scopes API.

    teamId#int64

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

    Possible values: >= 0

    userIds#string[]

    The user ids.

Response

application/json

Response containing the newly created team group.

    A Team Group entity.