PATCH group based on ID.

PATCH

/api/scim/namespaces/system/v2/Groups/{id}

curl --request PATCH \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/scim/namespaces/system/v2/Groups/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "Operations": [ { "op": "example", "path": "example", "value": {} } ], "id": "example", "schemas": [ "example" ] }'

• F5 Distributed Cloud Console

PATCH group based on the given ID.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

id

required

string

ID x-required unique ID for the group.

Request Body^required

Media typeapplication/json

PatchGroupOperation

PATCH operation to modify group.

object

Operations

Operations

Operations to modify or DELETE group. Required: YES.

Array<object>

PatchOperation

PatchOperation is the PATCH operation where user can be updated replaced or remove.. Supported op types are add, remove, replace remove is remove a specific entry.

object

op

op

Op “add”, “replace”, “remove”, “DELETE”

string

<= 1024 characters

path

path

Path to the field where the change needs to happen.

string

<= 1024 characters

value

value

Value to be used for modifying the object. In case of DELETE nothing needs to be specified.

object

id

id

Unique ID for the group. Required: YES.

string

>= 1 <= 4094 <= 1024 characters

schemas

schemas

Schemas as per scim spec. Required: YES.

Array<string>

Example^generated

{
  "Operations": [
    {
      "op": "example",
      "path": "example",
      "value": {}
    }
  ],
  "id": "example",
  "schemas": [
    "example"
  ]
}

Responses

200

A successful response.

Media typeapplication/json

Group

Group.

object

displayName

displayName

Display name for the group.

string

<= 1024 characters

externalId

ExternalId

External ID for the group.

string

<= 1024 characters

id

id

Unique ID for the group.

string

>= 1 <= 4094 <= 1024 characters

members

GroupMembers

Users with unique ID.

Array<object>

GroupMembers

GroupMembers.

object

ref

$ref

URL of the users or groups.

string

<= 1024 characters

value

value

Unique ID of the users or groups.

string

>= 3 characters <= 1024 characters

meta

object

created

created

Create date. Required: YES.

string

<= 1024 characters

lastModified

lastModified

Last modification date and time. Required: YES.

string

<= 1024 characters

location

location

[x-required] location for resource.

string

>= 4 characters <= 1024 characters

resourceType

resourceType

Type of resource. Required: YES.

string

<= 1024 characters

version

version

Version for resource type. Required: YES.

string

>= 1 characters <= 1024 characters

name

Name

Display name for the group.

string

>= 6 characters <= 1024 characters

schemas

schemas

Schemas per scim spec.

Array<string>

Example^generated

{
  "displayName": "example",
  "externalId": "example",
  "id": "example",
  "members": [
    {
      "ref": "example",
      "value": "example"
    }
  ],
  "meta": {
    "created": "example",
    "lastModified": "example",
    "location": "example",
    "resourceType": "example",
    "version": "example"
  },
  "name": "example",
  "schemas": [
    "example"
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example