Boomi MFT - File Sharing API Reference (1.16) - ImmutableImpersonateSession

Toggle Pane

• ImmutableImpersonateSession
  • postCreate Impersonated Session

API docs by Redocly

Download OpenAPI Specification: Download

ImmutableImpersonateSession

The ImmutableImpersonateSession API enables administrators to authenticate as another user without requiring that user's credentials. Any session generated using this endpoint is immutable.

Required privilege

You must have Administrator role to use the ImmutableImpersonateSession API.

Create Impersonated Session

Creates an immutable session impersonating the specified user.

Authorizations:

SessionAuth

header Parameters

X-Thru-SessionId required

string Session ID of the administrator making the request.

Request Body schema: application/x-www-form-urlencoded

required

UserID required	string Encrypted ID of the user to impersonate.
ApplicationID required	integer Application ID used by connecting application.

Responses

Response Schema: application/json

SessionId	string Encrypted session identifier for the impersonated user.
UserId	string Encrypted user identifier of the impersonated user.

https://{MFTWebServer}/REST/{version}/ImmutableImpersonateSession

Request samples

• Payload

Content type

application/x-www-form-urlencoded

UserID={encryptedUserId}&ApplicationID=25674

Response samples

• 200
• 400
• 403

Content type

application/json

{

• "SessionId": "string",
• "UserId": "string"

}