ATataccama
Groups

Update group

Update specific fields of a group using JSON Merge Patch (RFC 7396). You only need to send the fields you want to change.

patch/iam/v1/groups/{urn}

Request

Path parameters

urnstring uri required

A URN identifying a group resource in the IAM API.

To find a group's URN, use the Groups endpoints of the IAM API.

Format: urn:ata:{tenant}:iam:group:{uuid}

Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000

URN identifier of the group.

Request body

parentUrnstring uri

A URN identifying a group resource in the IAM API.

To find a group's URN, use the Groups endpoints of the IAM API.

Format: urn:ata:{tenant}:iam:group:{uuid}

Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.

namestring

Name of the group.

descriptionstring nullable

Human-readable description of the group's purpose. Set to null to clear it.

Example request

{
  "parentUrn": "urn:ata:acme-corp:iam:group:4b9d2e7f-6a1c-4d3e-8f5b-0a1b2c3d4e5f",
  "name": "Data Governance",
  "description": "Group responsible for data governance across the organization."
}

Response

The updated group.

urnstring uri required

A URN identifying a group resource in the IAM API.

To find a group's URN, use the Groups endpoints of the IAM API.

Format: urn:ata:{tenant}:iam:group:{uuid}

Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.

parentUrnstring uri

A URN identifying a group resource in the IAM API.

To find a group's URN, use the Groups endpoints of the IAM API.

Format: urn:ata:{tenant}:iam:group:{uuid}

Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.

namestring required

Name of the group.

descriptionstring

Human-readable description of the group's purpose.

Example response

{
  "urn": "urn:ata:acme-corp:iam:group:8e1f3a5c-9b2d-4c7e-a6f0-1d2e3c4b5a69",
  "parentUrn": "urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000",
  "name": "Data Governance",
  "description": "Group responsible for data governance across the organization."
}

Changes

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