Update Group

Update Group

Modify details of the specified group.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}
COPY
Path Parameters
string
groupUrn
Required

groupUrn

string
groupUrn
Required

groupUrn


Request Body
UserGroup of type(s) application/json
Optional
{
    "name": "string",
    "id": "string",
    "description": "string",
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "sourceEntityRef": {
        "name": "string",
        "id": "string"
    },
    "roleEntityRef": {
        "name": "string",
        "id": "string"
    },
    "nameInSource": "string",
    "providerType": "string"
}
string
name
Required

name

string
id
Optional

id

string
description
Required

description

orgEntityRef
Required

orgEntityRef

sourceEntityRef
Optional

sourceEntityRef

roleEntityRef
Required

roleEntityRef

string
nameInSource
Optional

nameInSource

string
providerType
Required

The provider type of the group. Valid values are:

  • LDAP
  • SAML
  • OAUTH
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserGroup of type(s) application/json;version=36.3
{
    "name": "string",
    "id": "string",
    "description": "string",
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "sourceEntityRef": {
        "name": "string",
        "id": "string"
    },
    "roleEntityRef": {
        "name": "string",
        "id": "string"
    },
    "nameInSource": "string",
    "providerType": "string"
}
string
name
Required

name

string
id
Optional

id

string
description
Required

description

orgEntityRef
Required

orgEntityRef

sourceEntityRef
Optional

sourceEntityRef

roleEntityRef
Required

roleEntityRef

string
nameInSource
Optional

nameInSource

string
providerType
Required

The provider type of the group. Valid values are:

  • LDAP
  • SAML
  • OAUTH