Close
logodocs

Generic SCIM Endpoint - Replace Group

The Replace Group endpoint will replace the requested Role in its entirety.

Request

Endpoint

/provisioning/generic/v2/Groups/<ID>

HTTP method

PUT

Path variables

VariableDescriptionRequired?NotesExample
IDThe Role IDRequiredReturns a 400 if the Role ID is invalid; returns a 404 if the role ID is not foundr-00001

Request body attributes

The following request body attributes are required.

AttributeDescriptionNotesExample
displayNameThe display name of the RoleReturns a 400 if the provided value is empty; returns a 409 if the provided value is already in use"RoleName"
membersA list of the members of the Role with subattributes value (User ID) and display (human-readable descriptor of the User, for your own use) of the User(s) to be assigned to the Role from creationReturns a 400 if the IDs are formatted incorrectly or are invalid; returns a 404 if User IDs are not found.{"value": "a-66f584886171b51d", "display": "userEmail@example.test"}
schemasThe schema URI for representing groupsInclude the value as indicated in the example."urn:ietf:params:scim:schemas:core:2.0:Group"

Example request

PUT app.strongdm.com/provisioning/generic/v2/Groups/r-00001

{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"displayName": "TestPutBasic",
"members": []
}

Response

Example success response

(Status 204)
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"displayName": "NewRoleName",
"id": "r-00001",
"members": [],
"meta": { "resourceType": "Group", "location": "Groups/r-00001" }
}

Example response if role ID is invalid

{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "could not parse provided role ID",
"status": "400"
}

Example response if role ID is not found

{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "Resource r-1230954 not found.",
"status": "404"
}

Example response if new Role name is empty

{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "could not update role name: cannot update role: invalid operation: name cannot be empty",
"status": "400"
}

Example response if user ID is malformed

{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "cannot parse member id: aa-123134",
"status": "400"
}
Previous
Generic SCIM Endpoint - List Groups
Next
Generic SCIM Endpoint - Update Group