Get application authentication methods

This method returns information about all the authentications methods of a specific application.

The user who runs this web service requires Audit Users permissions in the Vault.

URL

  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

 

 
https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Applications/{AppID}/Authentications/

The following mandatory value is required in the URL:

Parameter

Description

AppID

The name of the application about which information is returned.

Type: String

Resource information

HTTP method

Content type

GET

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64. See Authentication.

Type: String

Mandatory: Yes

Default value: None

Body parameters

None

Result

This is the structure of a result for a list of authentications:

 
{
"authentication":[
  {
   "AllowInternalScripts":<bool>,
   "AppID":"<string>",
   "AuthType":"<the authentication type name>",
   "AuthValue":"<string>",
   "Comment":"<for hash auth use string, else null>",
   "IsFolder":"<for hash auth use string, else null>",
   "authID":"<authID>"
  }
 ]
}

This is an example of a result for multiple machineAddress authentications:

 
{
"authentication": [
 {
  “AllowInternalScripts": null,
  "AppID": "Ansible",
  "AuthType": "machineAddress",
  "AuthValue": "ansible.192.168.3.103.xip.io",
  "Comment": null,
  "IsFolder": null,
  "authID": 1 
  }
  ,

  {
  "AllowInternalScripts": null,
  "AppID": "Ansible",
  "AuthType": "machineAddress",
  "AuthValue": "192.168.3.103",
  "Comment": null,
  "IsFolder": null,
  "authID": 2 
  }
  ,

  {
  "AllowInternalScripts": null,
  "AppID": "Ansible",
  "AuthType": "machineAddress",
  "AuthValue": "ansibletower",
  "Comment": null,
  "IsFolder": null,
  "authID": 3 
  }
 ]
}

This is an example of a result for machineAddress, osUser, path, or hashValue authentications:

 
{
"authentication":[
  {
   "AllowInternalScripts":<bool>,
   "AppID":"<string>",
   "AuthType":"<machineAddress, osUser, path, or hashValue>",
   "AuthValue":"<string>",
   "Comment":"<for hash auth use string, else null>",
   "IsFolder":"<for hash auth use string, else null>"
   "authID":"<authID>"
  }
 ]
}

This is an example of a result for Certificate attributes authentication:

 
{
"authentication":[
  {
   "AppID":"<string>",
   "AuthType":"certificateattr",
   "Comment":"<string>",
   "Subject":"<string>",
   "Issuer":"<string>",
   "SubjectAlternativeName": "<string>",
   "authID":"<authID>"
  }
 ]
}

Return codes

For a complete list of return codes, see Return Codes.