Modify group membership

PATCH /Groups/{identifier}

Adra personal access token

Modify group members using SCIM PATCH operations

Path parameters

identifier string Required

Identifier of the group to modify

application/json

Body Required

operations array[object] | null Required
Hide operations attributes Show operations attributes object
- value array[object]
  Hide value attribute Show value attribute object
  
  value string
- op string Required
  
  Values are Add, Remove, or Replace.
- path string Required
schemas array[string] | null Required

Responses

200 application/scim+json

OK
Hide response attributes Show response attributes object
- meta object | null
  
  Additional properties are NOT allowed.
  
  Hide meta attribute Show meta attribute object | null
  
  resourceType string | null
- displayName string | null
  
  The display name of the group, typically in format 'Organization|Product|Role'
- members array[object] | null
  
  Hide members attributes Show members attributes object
  
  type string
  
  value string
  
  The identifier of the member
- id string | null
- schemas array[string] | null
204

Operation successful
400 application/scim+json

Bad Request
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
401 application/scim+json

Unauthorized
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
403 application/scim+json

Forbidden
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
500 application/scim+json

Internal Server Error
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
501 application/scim+json

Not Implemented
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null

PATCH /Groups/{identifier}

curl \
 --request PATCH 'https://setup.adra.com/api/organizations/{organizationSid}/scim/Groups/{identifier}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"members","value":[{"value":"9876fedc-ba09-8765-4321-0fedcba98765"}]}]}'

Request example

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "9876fedc-ba09-8765-4321-0fedcba98765"
        }
      ]
    }
  ]
}

Response examples (200)

{
  "meta": {
    "resourceType": "string"
  },
  "displayName": "string",
  "members": [
    {
      "type": "User",
      "value": "string"
    }
  ],
  "id": "string",
  "schemas": [
    "string"
  ]
}

Response examples (400)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (401)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (403)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (500)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (501)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}