Visit Rightsline
logo
Powered by Redocly

Security

The Security API is a set of endpoints that allow your applications to log on, log off, and discover Alliant System and Application Layers.'

Login

Log in to Alliant to acquire an Alliant session Security Token. An Alliant session Security Token is returned in token response property. It is valid until the time indicated in the expires response property or until a you logout. You must pass the Alliant session Security Token to all requests that require TokenAuth in the HTTP X-AlliantSession request header.

SecurityBasicAuth
Request
query Parameters
systemLayer
required
string

System Layer Name. You can request a list of the Alliant System Layers configured on the Web Server using the List the Alliant System Layers endpoint.

Example: systemLayer=Alliant
applicationLayer
required
string

Application Layer Name. You can request a list of the Alliant Application Layers configured on the Web Server using the List the Alliant Application Layers for a specific Alliant System Layer endpoint.

Example: applicationLayer=Alliant_prod
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/api/security/login
Response samples
application/json
{
  • "result": {
    },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Logout

Log off the Alliant User associated with an Alliant session Security Token provided in the request. This request invalidates the Alliant session Security Token.

SecurityHeaderToken
Responses
200

OK

500

Internal Server Error

post/api/security/logout
Response samples
application/json
{
  • "result": "Bye",
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

List the Alliant System Layers

Request a list of the Alliant System Layers that are available on the Alliant Web Server.

Responses
200

OK

500

Internal Server Error

get/api/security/systemLayers
Response samples
application/json
{
  • "result": [
    ],
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

List the Alliant Application Layers for an Alliant System Layer

Request a list of the Alliant Application Layers that are available for a System Layer on the Alliant Web Server.

Request
path Parameters
systemLayer
required
string

Name of the Alliant System Layer on the Alliant Web Server

Example: Alliant
Responses
200

OK

404

Not Found

500

Internal Server Error

get/api/security/systemLayers/{systemLayer}/applicationLayers
Response samples
application/json
{
  • "result": [
    ],
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}
➔ Next to Adjustments