Update impersonation settings

PUT /api/2.0/security/impersonate/settings

Request

Uppdates the impersonation settings with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

enableboolean

Specifies whether impersonation is enabled or not

enableTypeinteger

Specifies for whom impersonation is enabled (DisableForAdmins, EnableForAllFullAdmins, or EnableWithLimits)

onlyForOwnGroupsboolean

Specifies if impersonation is enabled only for the current user groups or not

allowedAdminsarray of string

List of admins who can be impersonated

restrictionUsersarray of string

List of users who cannot be impersonated

restrictionGroupsarray of string

List of groups who cannot be impersonated

Examples

PUT /api/2.0/security/impersonate/settings HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url https://example.com/api/2.0/security/impersonate/settings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated impersonation settings

Enabledboolean

EnableTypeenum of integerformat: int32

[0 - DisableForAdmins, 1 - EnableForAllFullAdmins, 2 - EnableWithLimits]

Can be one of: DisableForAdmins, EnableForAllFullAdmins, EnableWithLimits.

OnlyForOwnGroupsboolean

AllowedAdminsarray of string

RestrictionUsersarray of string

RestrictionGroupsarray of string

401

Unauthorized