Skip to content
API Enriched

Replace group based on ID.

PUT
/api/scim/namespaces/system/v2/Groups/{id}
curl --request PUT \
  --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 '{ "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" ] }'

Replace group based on the given ID.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

ID unique ID for the group.

Request Bodyrequired

Section titled “Request Bodyrequired”
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>
Examplegenerated
{
  "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"
  ]
}

Responses

Section titled “Responses”

200

Section titled “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>
Examplegenerated
{
  "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

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example