SecurityTokenExchangeCredentials()

This API call is used to create a new SecurityToken by exchanging a user’s credentials.

This API is used to create a SecurityToken for a user recently created with AccountUserCreate() or UserCreate().

API URL:

[BaseURL]/SecurityToken/SecurityTokenExchange[?duration={Duration}]

Request Method:

POST

Request Parameters:

Duration is the optional number of days the SecurityToken should be valid for

Request Format

XML type:

dece:UserCredentials-type

Required information:

Credentials
- Username

Optional information:

/Credentials/Password

If AccountUserCreate() or UserCreate() was called to create a new User without a Password, then this element should be excluded, otherwise this value is required.

Response Format

Status Code:

HTTP 201 Created

Headers:

Location: [BaseURL]/SecurityToken/Assertion/{AssertionID}

A reference to the newly created SAML Assertion

Errors

securitycontext:forbidden:1122
- Incorrect password (the Password element was excluded but is required or the Password value is incorrect); The duration value is invalid; The user referenced by the credentials was not created by the requesting Node
- HTTP Status Code: 403 Forbidden
InvalidDurationValue
- Duration was provided, but was invalid.
- HTTP Status Code: 400

Example

Create a new SecurityToken by exchanging user credentials

The following example will create a new SecurityToken by exchanging user credentials.

Sample Request:

POST /rest/2015/02/SecurityToken/SecurityTokenExchange HTTP/1.1
Host: api.uvvu.com
Content-type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Credentials xmlns="http://www.decellc.org/schema/2015/03/coordinator">
    <Username>test_-_cl-6fd3bf83-5412-4fe9-856f-36e1c72e4ca0</Username>
    <Password>P4SsWo.Rd_super12.Long</Password>
</Credentials>

Sample Response:

HTTP/1.1 201
Date: [Date]
Location: https://api.uvvu.com/rest/2015/02/SecurityToken/Assertion/_1914d5f8-5fce-4436-9dc1-803adea311d8
X-transaction-info: [TransactionInfo]