To get the details for a specific authentication module, use the URL <baseURL>/appserver/authmodules/{id}
|
HTTP method |
URI |
Body |
|---|---|---|
|
Get |
<BaseURL>/appserver/authmodules/{id} |
None |
|
Parameter |
Description |
Parameter type |
Data type |
|---|---|---|---|
|
id |
Authentication module (required) |
path |
string |
[{
"id": String,
"caption": String,
"authTemplate": String,
"passwordBased": Boolean,
"isDefault": Boolean
}]
https://<Hostname>/AppServer/appserver/authmodules/DialogUser
[{
"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.
|
HTTP method |
URI |
Body |
|---|---|---|
|
Post |
<BaseURL>/auth/apphost |
Property authString containing an authentication string. For more information, see Initial data for authentication modules. |
{"authString": String}
{
"claims": {
"http://schemas.oneidentity.com/ws/2017/04/identity/claims/identifier": String,
"http://schemas.oneidentity.com/ws/2017/04/identity/claims/useruid": String,
"http://schemas.oneidentity.com/ws/2017/04/identity/claims/module": String
},
"passwordBased": Boolean,
"moduleDisplay": String,
"sessionId": String,
"userName": String,
"responseStatus": {}
}
https://<Hostname>/AppServer/auth/apphost
{"authString":"Module=DialogUser;User=<user name>;Password="}
{
"claims": {
"http://schemas.oneidentity.com/ws/2017/04/identity/claims/identifier": "<user name>",
"http://schemas.oneidentity.com/ws/2017/04/identity/claims/useruid": "QBM-A60F9E5189134AFFB6711DFCBC3F260E",
"http://schemas.oneidentity.com/ws/2017/04/identity/claims/module": "DialogUser"
},
"passwordBased": true,
"moduleDisplay": "System user",
"sessionId": "nV8R3iw4KfmEiZydA3uy",
"userName": "<user name>",
"responseStatus": {}
}
© 2025 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
