To get the details for a specific authentication module, use the URL <baseURL>/appserver/authmodules/{id}.
Table 3: Get authentication module request
|
Get |
<BaseURL>/appserver/authmodules/{id} |
None |
Table 4: Get authentication module parameters
|
id |
Authentication module (required) |
path |
string |
Response schema:
[{
"authTemplate": String,
"passwordBased": Boolean,
"isDefault": Boolean
}]
Example:
https://<Hostname>/AppServer/appserver/authmodules/DialogUser
Response:
[{
"id": "DialogUser",
"caption": "System user",
"authTemplate": "Module=DialogUser;User[VI.DB_USER]=;(Password)Password[VI.DB_Password]=",
"passwordBased": true,
"isDefault": false
}]
The values in the property authTemplate can be used to identify the format of the authString needed to authenticate against the application server. You can ignore the parts in [] and () as those are the caption keys and value types used in the front ends only.
For example, a valid authentication string would be Module=DialogUser;User=MyUser;Password=$ecret.
To use the One Identity Manager REST API, you first have to authenticate against the application server.
Body schema:
{"authString": String}
Response schema:
{
"claims": {
"id": String,
"useruid": String,
"module": String
},
"passwordBased": Boolean,
"moduleDisplay": String,
"sessionId": String,
"userName": String,
"responseStatus": {}
}
Example:
https://<Hostname>/AppServer/auth/apphost
Body:
{"authString":"Module=DialogUser;User=<user name>;Password="}
Response:
{
"claims": {
"id": "<user name>",
"useruid": "QBM-A60F9E5189134AFFB6711DFCBC3F260E",
"module": "DialogUser"
},
"passwordBased": true,
"moduleDisplay": "System user",
"sessionId": "nV8R3iw4KfmEiZydA3uy",
"userName": "<user name>",
"responseStatus": {}
}
If you want to end your session against the One Identity Manager REST API you can use the logout request.
Table 6: Logout request
|
Post |
<BaseURL>/auth/logout |
|
Response schema:
{"responseStatus": {}}
Example:
https://<Hostname>/AppServer/auth/logout
Response:
{"responseStatus": {}}
If date values have to be specified in requests for changing or adding objects using the REST API, these have to be specified in the ISO 8601 format in UTC.
Example:
2016-03-19T13:09:08.123Z, which is March 19, 2016, 1:09:08.123 PM UTC
