PUT Teams/RenameTeam

Renames a local Team. When you rename a team, the Policy folders that were automatically created with the old team name, will also be renamed.

Requirements

Permissions: The caller must have Owner permission or have Master Admin permission.
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

Input parameters
Name	Description
Team	The PrefixedName, the word local and the Team name. For example PrefixedName:local:MyTeam.
NewTeamName	The new, unique Team name.

Returns

Response description
Name	Description
HTTP 200	For valid requests, Teams/RenameTeam returns a HTTP 200 message and the following data: ID: The Identity Entry object that represents the renamed group. See the code example for exact return values. Message: The operation succeeded.
HTTP 400	If the response is a HTTP 400, it only contains Message and the reason for failure. Omits all other return values. Failed to rename the team: [Config result codes]

Example: Rename a local Team

Request for Example

PUT https://tpp.venafi.example/vedsdk/Teams/RenameTeam
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Team":{
      "PrefixedName":"local:Apache Team2"
   },
   "NewTeamName":"DevOpsTeam"
}

Response for Example

{
   "ID":{
      "FullName":"\\VED\\Identity\\DevOpsTeam",
      "IsGroup":true,
      "Name":"DevOpsTeam",
      "Prefix":"local",
      "PrefixedName":"local:DevOpsTeam",
      "PrefixedUniversal":"local:{8b576a8a-2a60-4268-a7d3-6d460e0e3781}",
      "Type":2,
      "Universal":"{8b576a8a-2a60-4268-a7d3-6d460e0e3781}"
   },
   "Message":"The operation succeeded."
}