Status | ||||
---|---|---|---|---|
|
...
An authentication code and client id are not directly used to access the APIs - a user will first have to call the Authenticate API (see below) and acquire a short-lived access token. All of the actual API calls will then be made using this token. Once a token expires, users will need to acquire a new one, using either the original authentication code, or using a refresh token provided by the Authenticate API (refresh tokens are not implemented at the moment).
Jira Legacy | ||||||||
---|---|---|---|---|---|---|---|---|
|
...
Making API calls
The APIs listed below are available via HTTPS requests (see the specific API documentation for details).
...
curl -d "" -H "code:<your user API authorization code>" "https://<your inspera domain>/api/authenticate/token/ ?grant_type=authorization_code&client_id=<your client_id>"
All the APIs assume a base url in the following format:
https://<your inspera domain>/api
In this table you will find key values for API authentication:
Value | |
---|---|
URL | /api/authenticate/token/ |
Method | POST |
URL Parameters: *required | |
grant_type* | authorization_code |
client_id* | (string), please see above for more details on how to obtain this information) |
HEADER Parameters: *required | |
code* | (string) |
Data Parameters: (required for POST) | |
Content-Type | application/x-www-form-urlencoded |
Responses: | |
200 | Success Returns:
|
400 | Error: Bad request Returns:
|
401 | Error: Unauthorized Returns:
|
409 | Error: Conflict Returns:
|
500 | Error: Internal server error Returns:
|
501 | Error: not implemented |
...