Sign in
Group Mappings (iam/v2/sso)

Update a Group Mapping

General Availability

Make a request to update a group mapping.

patch/iam/v2/sso/group-mappings/{id}

Path parameters

idstring required

The unique identifier for the group mapping.

Request body

api_version'iam.v2/sso'

APIVersion defines the schema version of this representation of a resource.

kind'GroupMapping'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

The name of the group mapping.

descriptionstring

A description explaining the purpose and use of the group mapping.

filterstring

A single group identifier or a condition based on supported CEL operators that defines which groups are included.

principalstring

The unique federated identity associated with this group mapping.

statestring

The current state of the group mapping.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam.v2/sso/group-mappings/gm-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/group-mapping=gm-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "Application Developers",
  "description": "Admin access to production environment for Engineering",
  "filter": "\"kafka\" in groups && \"all\" in groups || \"everyone\" in groups",
  "principal": "group-a1b2",
  "state": "ENABLED"
}

Response

Group Mapping.

api_version'iam.v2/sso' required

APIVersion defines the schema version of this representation of a resource.

kind'GroupMapping' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring required

The name of the group mapping.

descriptionstring required

A description explaining the purpose and use of the group mapping.

filterstring required

A single group identifier or a condition based on supported CEL operators that defines which groups are included.

principalstring required

The unique federated identity associated with this group mapping.

statestring required

The current state of the group mapping.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam.v2/sso/group-mappings/gm-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/group-mapping=gm-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "Application Developers",
  "description": "Admin access to production environment for Engineering",
  "filter": "\"kafka\" in groups && \"all\" in groups || \"everyone\" in groups",
  "principal": "group-a1b2",
  "state": "ENABLED"
}

Changes

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