Update a group

PATCH https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Updates a group's information. Using this endpoint you can:

  • Update a group's name.
  • Add or remove members from a Qodex group.

Include the following properties in the request body:

  • Operations — An object that contains the following properties:
    • op — The operation to perform. One of:
      • add
      • remove
      • replace
    • value — An object that contains the following properties:
      • id — The group's ID.
      • displayName — The group's display name.

Request Body

{"schemas"=>["urn:ietf:params:scim:api:messages:2.0:PutOp"], "Operations"=>[{"op"=>"{{operation}}", "value"=>{"id"=>"{{groupId}}", "displayName"=>"{{userGroupName}}"}}]}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00","displayName":"Test-API","members":[{"value":"23a35c2723d34c03b4c56443c09e7173","display":"taylor.lee@example.com"}],"externalId":"1234","meta":{"resourceType":"Group","created":"2022-02-22T04:24:13.000Z","lastModified":"2022-02-22T04:24:13.000Z"}}