Check status endpoint

  • Checks the status of the Web API.

  • HTTP methods supported: GET.

Examples

HTTP GET

Request URL

  • /api/checkstatus

Response body

{
  "status": "OK",
  "message": "Status is OK.",
  "dependencies": [
    {
      "name": "ChannelAgent",
      "status": "OK",
      "message": "Status is OK."
    }
  ]
}

Version endpoint

  • Retrieves the version of the Web API.

  • HTTP methods supported: GET.

Examples

HTTP GET

Request URL

  • /api/version

Response body
{
  "inmationWebAPI": "0.1.0.1"
}

Version info endpoint

  • Retrieves the version of the Web API (dependencies included).

  • HTTP methods supported: GET.

Examples

HTTP GET

Request URL

  • /api/versioninfo

Oauth2 token endpoint

  • Endpoint to acquire an access token.

  • HTTP methods supported: POST.

Parameters

Name Type Optional Description

grant_type

string

no

Supported grant type is 'password'.

authority

string

no

Supported authorities are 'builtin', 'ad' and 'machine'.

username

string

yes

Required for the authorities 'builtin', 'ad' and 'machine'. For authority 'builtin' Profile Credentials must be provided. For 'ad' an Active Directory (domain) account and for 'machine' a Windows local account name. Supported username formats are User Principal Name (UPN) and Down-Level Logon Name.

password

string

yes

Required for the grant type 'password'.

include_claims

string

yes

Comma separated string or string array to define which optional claims should be included in the access token. Supported claims are 'email,family_name,given_name,middle_name,phone_number'. Only supported in combination with authority 'ad'.

Examples

The Web API Oauth2/token endpoint is a token generator, the parameter type is formData. The FormData interface provides a way to easily construct a set of key/value pairs representing the request body, which can then be easily sent using the content-type application/x-www-form-urlencoded.

HTTP POST

Request URL

  • /api/oauth2/token

Response Body

{
  "access_token": "%ACCESS_TOKEN%",
  "token_type": "Bearer",
  "expires_in": "%EXPIRATION%"
}