This service creates a user alias token that allows an external application to perform actions within your XNAT as a valid logged-in user. This service should be used with caution.
Contents
Issue A New User Alias Token
GET - /data/services/tokens/issue
Parameters: None, but requires an authenticated session to function
Response: Returns an alias token object for the logged-in user account
{
"alias": "string",
"xdatUserId": "string",
"secret": "string",
"singleUse": boolean,
"estimatedExpirationTime": timestamp,
"timestamp": timestamp,
"enabled": boolean,
"created": timestamp,
"id": integer,
"disabled": integer
}
Validate A User Alias Token
GET - /data/services/tokens/validate/{token}/{secret}
Parameters:
| {token} | Required path parameter |
|---|---|
| {secret} | Required path parameter |
Response:
If token is valid
{"valid":"username"}
If token is invalid
{}
Invalidate A User Alias Token
GET - /data/services/tokens/invalidate/{token}/{secret}
Parameters:
| {token} | Required path parameter |
|---|---|
| {secret} | Required path parameter |
Response: None