PUT Administrators({id})

Update an existing administrator.

Request Information

Parameters

Name	Description	Additional information
id	The ID of the administrator you wish to update.	Type: String
changeId	See Optimistic Concurrency.	Type: String

Request body type

UpdateAdministratorModel

Request body formats

application/json, text/json

Sample:

{
  "Category": "SingleRole",
  "RoleId": "FCE10C6A-4518-4949-A88A-6081B57E0EA9",
  "IsRoleScoped": true,
  "RoleScopesIds": [
    "5e531466-5c6d-41c8-97e1-d814d261f322"
  ],
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}

Response Information

The updated administrator.

Response type

AdministratorModel

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:Administrators(c52689f8-7ae8-4f99-ab33-08a4814e6ab9)]",
  "RelatedActions": [
    {
      "Name": "UpdateAdministrator",
      "References": [
        {
          "Href": "[api:Administrators(5e531466-5c6d-41c8-97e1-d814d261f323)]",
          "Name": "DOMAIN\\ReadOnlyAdmins",
          "Id": "5e531466-5c6d-41c8-97e1-d814d261f323"
        }
      ]
    }
  ],
  "Id": "c52689f8-7ae8-4f99-ab33-08a4814e6ab9",
  "Name": "DOMAIN\\ReadOnlyAdmins",
  "ChangeId": "4",
  "IsUserGroup": true,
  "Category": "SingleRole",
  "RoleId": "FCE10C6A-4518-4949-A88A-6081B57E0EA9",
  "RoleName": "ReadOnly",
  "IsRoleScoped": true,
  "RoleScopes": [
    {
      "Id": "5e531466-5c6d-41c8-97e1-d814d261f322",
      "Category": "Tenant",
      "Name": "Tenant 1"
    }
  ],
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}