PUT Identity/RenameGroup
Renames a group in an identity provider.
Requirements
- Permissions: The caller must have Owner permission or have Master Admin permission. However, results are limited to the identity provider that authenticated the caller. For example, if a LDAP caller tries to change information about an AD identity, the API call returns an empty JSON result.
- Token scope: Configuration:Manage
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
Name |
Description |
---|---|
Group |
The user or group name. |
NewGroupName | The new, unique group name. |
Returns
Name |
Description |
---|---|
HTTP 200 |
For valid requests, Identity/RenameGroup returns a HTTP 200 message and the following data:
|
HTTP 400 |
If the response is a HTTP 400, it only contains Message and the reason for failure. Omits all other return values.
|
Example: Rename a local identity group
Request for Example
PUT https://tpp.venafi.example/vedsdk/Identity/RenameGroup Authorization:Bearer 4MyGeneratedBearerTknz== { "Group":{ "PrefixedName":"local:Apache Team" }, "NewGroupName":"RedHat" }
Response for Example
HTTP/1.1 200 OK { "ID":{ "FullName":"\\VED\\Identity\\Redhat", "Name":"RedHat", "Prefix":"local", "PrefixedName":"local:Redhat", "PrefixedUniversal":"local:{5c84d045-b4b7-48cf-a187-0b25d5c704a0}", "Type":2, "Universal":"{5c84d045-b4b7-48cf-a187-0b25d5c704a0}" } }