uAlign API: Introduction

Introduction

ANCILE uAlign has enabled API endpoints as an interface for developers wishing to provision users programmatically via SCIM. The API supports serialized JSON. All requests and responses must be secured and have the ‘application/json’ content-type header.

 

Versioning

ANCILE uAlign keeps the current and previous versions of its API active. The version of the API is referenced inside the base URL. All ANCILE uAlign API endpoints in the documentation use a base URL over HTTPS.

https://:host/api/:version

• The current API base URL for uAlign is https://app.ancileualign.com/api/v4
• The current API base URL for SAP Communication Center (SCC) is https://scc.ancileualign.com/api/v4 

 

Authorization Header

The ANCILE uAlign application requires an OAuth 2.0 authorization header for API calls. ANCILE uAlign supports OAuth's client credential authorization grant type.  To obtain an authorization header, perform the following steps:

1. Login to the uAlign website.
2. Ensure that the proper organization name is displayed in the upper left.
3. Click the Settings icon in the upper right.
4. Click Organization.
5. In the Authentication settings portion of the screen, click the Manage connected applications link to go the Your Applications window.
6. In the Your Applications window, click Add application to create a new connected application.
7. In the Name field, enter the name of the connected application as you want it to appear in the list of applications.
8. In the Redirect URI field, enter the callback entry point of the application.
9. Click Save.
10. A screen is displayed containing the ID and Secret Key. Copy and store this information in a safe place. The secret key will not be displayed again.
11. Use the ID and Secret Key to make a POST request to /oauth/token as follows:

Request:

POST /oauth/token

Request Body:

{"client_id":"[id]","client_secret":"[secretkey]","grant_type":"client_credentials"
}

Response:

Status: 200 OK

Response Body:

{"access_token":"[token]","token_type":"bearer","expires_in":7200,"created_at":1461960661
}

On subsequent API calls that require an Authorization header, use the token provided in the POST response as follows:

Authorization: Bearer [token]

The response body contains a "expires_in" attribute, which is the number of seconds that the token will be valid. After expiration, all clients must make a new request to the /oauth/token endpoint to obtain a new valid token. 

 

Organization Identifier Header

In addition to the authorization header, the organization identifier must be passed in a custom header. If no organization identifier is passed, the organization used will be the user's last selected organization, or the organization that owns the client application. To find a specific organization identifier, access the organization's page in uAlign and note the identifier displayed in the browser address.

On subsequent API calls, add the 'x-uAlign-Organization' header with the organization identifier value as follows:

X-uAlign-Organization: [organization_uuid]

 

API Endpoints

ANCILE uAlign provides an application programmatic interface in order to read and write data. The API provides access to the following objects:

• Users API
  • List
  • Show
  • Add
  • Update
  • Remove
  • Sample Full User Response