Chat now with support
Chat with Support

Identity Manager 8.0 - REST API Reference Guide

Getting details of an authentication module

To get the details for a specific authentication module use the URL: <baseURL>/appserver/authmodules/{id}

Table 3: Get authentication module request

HTTP Method

URI

Body

Get

<BaseURL>/appserver/authmodules/{id}

None

Table 4: Get authentication module Parameters

Parameter

Description

Parameter Type

Data Type

id

Authentication module (mandatory)

path

string

Response schema:

[{

"id": String,

"caption": String,

"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 valueTemplate 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 frontends only.

For the sample a valid authentication string would be Module=viadmin;User=MyUser;Password=$ecret.

Login

To use the One Identity Manager REST API you first have to authenticate against the application server.

Table 5: Authenticate Request

HTTP Method

URI

Body

Post

<BaseURL>/auth/apphost

Property authString containing an authentication string. For more information, see Initial Data for authentication modules.

Body schema:

{"authString": String}

Response schema:

{

"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": {}

}

Example

https://<Hostname>/AppServer/auth/apphost

Body:

{"authString":"Module=DialogUser;User=<user name>;Password="}

Response:

{

"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": {}

}

Related Documents