Getting a list of Active Directory servers

Execution permission

You must be a system administrator or a security administrator.

Request line

GET base-URL/security/v1/external-user-storage

Request message

Object ID

None.

Query parameters

None.

Body

None.

Response message

Body

[
    {
        "id": "1022c8b2-934e-4097-8112-64b0274a3653",
        "name": "ldap-srv2",
        "priority": 1,
        "userAuthenticationProtocol": "LDAP",
        "vendor": "ACTIVE_DIRECTORY",
        "connectionUrl": "ldaps://vm.ldap-srv2.soft.example.co.jp",
        "baseDn": "CN=Users,DC=ldap-srv2,DC=soft,DC=example,DC=co,DC=jp",
        "bindDn": "admin@ldap-srv2.soft.example.co.jp",
        "bindPassword": null,
        "groupEntryDnList": [
            "CN=admins,CN=Users,DC=ldap-srv2,DC=soft,DC=example,DC=co,DC=jp",
            "CN=users,CN=Users,DC=ldap-srv2,DC=soft,DC=example,DC=co,DC=jp"
        ],
        "kerberosRealm": null,
        "enabled": true,
        "defaultGroupMappingEnabled": false
    }
]

Attribute	Type	Description
id	string	Object ID
name	string	Server name
priority	int	Priority
userAuthenticationProtocol	string	Authentication method LDAP Kerberos
vendor	string	Type of directory service A fixed string (ACTIVE_DIRECTORY) is returned.
connectionUrl	string	URL of the connection-destination Active Directory server
baseDn	string	BaseDN
bindDn	string	Bind DN
bindPassword	string	Password for the bind DN
groupEntryDnList	string[]	List of DNs of the groups to be synchronized
kerberosRealm	string	Realm name for Kerberos authentication If the value of the userAuthenticationProtocol attribute is LDAP, the value null is always returned.
enabled	boolean	Whether the server setting is enabled true: Enabled false: Disabled
defaultGroupMappingEnabled	boolean	Whether the Active Directory users are allocated to the opscenter-users group true: The users are allocated to the group false: The users are not allocated to the group

Coding example

curl -v -X GET -s "https://example.com:443/portal/security/v1/external-user-storage" -H "Authorization:Bearer eyJhbxxx"