UserGet()

This API call is used to retrieve User descriptive information for a unique AccountID and UserID pair.

API URL:

[BaseURL]/Account/{AccountID}/User/{UserID}

Request Method:

GET

Request Parameters:

AccountID is the unique identifier for an Account
UserID is the unique identifier for a User

Request Format

Headers:

Authorization: SAML2 assertion=[Assertion]

Response Format

XML type:

dece:UserData-type

Status Code:

HTTP 200 Ok

Errors

SecurityContextForbidden
- The request is not authorized
- HTTP Status Code: 403
AccountIdUnmatched
- The specified AccountId did not match the AccountId in the assertion
- HTTP Status Code: 403
UserIdInvalid
- The specified UserID is invalid or the user cannot be found
- HTTP Status Code: 400
NotFound
- User was not found
- HTTP Status Code: 404
AccountUserStatusDeleted
- User’s status is deleted
- HTTP Status Code: 400

Example

Get a User by AccountID and UserID

The following example retrieves a Users descriptive information for a unique AccountID and UserID pair.

Sample Request:

GET /rest/2015/02/Account/urn:dece:accountid:org:dece:0AB299E7D3BD486C9EED75B20CA426AE/User/urn:dece:userid:org:dece:C4F3D6FD8A6C44CE93D262C1D074A30E HTTP/1.1
Host: api.uvvu.com
Accept: application/xml
Authorization: SAML2 assertion=[Assertion]

Sample Response:

HTTP/1.1 200
Etag: [Etag]
Date: [Date]
Content-Type: application/xml
Last-modified: [LastModified]
X-transaction-info: [TransactionInfo]

<?xml version="1.0" encoding="UTF-8"?>
<User xmlns="http://www.decellc.org/schema/2015/03/coordinator" UserClass="urn:dece:role:user:class:full" UserID="urn:dece:userid:org:dece:C4F3D6FD8A6C44CE93D262C1D074A30E">
    <Name>
        <GivenName>John</GivenName>
        <SurName>The Test</SurName>
    </Name>
    <ContactInfo>
        <PrimaryEmail>
            <Value>test_-_cl-53a215c2-b3f0-4d93-8f80-c6e08b605e7b@uvvutesting.biz</Value>
        </PrimaryEmail>
        <Address>
            <Country>US</Country>
        </Address>
    </ContactInfo>
    <Languages>
        <Language primary="true">en-US</Language>
    </Languages>
    <Credentials>
        <Username>test_-_cl-53a215c2-b3f0-4d93-8f80-c6e08b605e7b</Username>
    </Credentials>
    <ResourceStatus>
        <Current CreatedBy="urn:dece:org:org:dece:iot:falcon-a1:retailer" CreationDate="2017-05-21T19:30:09.504Z">
            <Value>urn:dece:type:status:active</Value>
        </Current>
    </ResourceStatus>
</User>