Impersonation

Impersonation is used for Support team to login as Actual user

Enable / Disable Impersonation

Impersonate User Add API

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed/api/v1/organization/{tenant_id}/users/impersonate/enable/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}

List Impersonation Allowed Users

Impersonate User Details API

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

405

Method Not Allowed

get/unifed/api/v1/organization/{tenant_id}/users/impersonate/

Request samples

Response samples

200
400
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"total": 10,
"page_number": 1,
"users": [{"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<string>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
},
{"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<string>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
}
]
}
}

Add Impersonation Users

Impersonate User Add API

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed/api/v1/organization/{tenant_id}/users/impersonate/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}

Exclude user for Impersonation

Impersonate User Exclusion API

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed/api/v1/users/{tenant_id}/impersonate/exclusion/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}