sources_scim_groups_update

PUT 
/api/v3//sources/scim_groups/:id/

SCIMSourceGroup Viewset

Request

Path Parameters

id stringrequired

A unique value identifying this scim source group.

application/json

Body

required

id stringrequired

Possible values: non-empty

group uuidrequired
source uuidrequired
attributes

Responses

200

application/json

Schema

Schema

id stringrequired
group uuidrequired

group_obj

object

required

Simplified Group Serializer for user's groups

pk uuidrequired

num_pk integerrequired

Get a numerical, int32 ID for the group

name stringrequired

Possible values: <= 80 characters

is_superuser boolean

Users added to this group will be superusers.

parent uuidnullable

parent_name stringnullablerequired

attributes object
source uuidrequired
attributes

Example (from schema)

{
  "id": "string",
  "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "group_obj": {
    "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "num_pk": 0,
    "name": "string",
    "is_superuser": true,
    "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parent_name": "string",
    "attributes": {}
  },
  "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "attributes": {}
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '/api/v3/sources/scim_groups/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "id": "string",
  "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "attributes": {}
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body required

{
  "id": "string",
  "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "attributes": {}
}