Sonatype Nexus Enterprise LDAP Plugin API

Data

  • Default Namespace
  • XML Schema File: ns0.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element connectionInfoTest

Request wrapper object that contains the connection info

Example XML

<?xml version="1.0" encoding="UTF-8"?> <connectionInfoTest> <data> <!--content of type 'ldapConnectionInfo'--> <authScheme> <!--content of type 'string'--> ... </authScheme> <backupMirrorHost> <!--content of type 'string'--> ... </backupMirrorHost> <backupMirrorPort> <!--content of type 'int'--> ... </backupMirrorPort> <backupMirrorProtocol> <!--content of type 'string'--> ... </backupMirrorProtocol> <cacheTimeout> <!--content of type 'int'--> ... </cacheTimeout> <connectionRetryDelay> <!--content of type 'int'--> ... </connectionRetryDelay> <connectionTimeout> <!--content of type 'int'--> ... </connectionTimeout> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <protocol> <!--content of type 'string'--> ... </protocol> <realm> <!--content of type 'string'--> ... </realm> <searchBase> <!--content of type 'string'--> ... </searchBase> <systemPassword> <!--content of type 'string'--> ... </systemPassword> <systemUsername> <!--content of type 'string'--> ... </systemUsername> </data> </connectionInfoTest>

Example JSON

{ "data" : { "authScheme" : "...", "backupMirrorHost" : "...", "backupMirrorPort" : ..., "backupMirrorProtocol" : "...", "cacheTimeout" : ..., "connectionRetryDelay" : ..., "connectionTimeout" : ..., "host" : "...", "port" : ..., "protocol" : "...", "realm" : "...", "searchBase" : "...", "systemPassword" : "...", "systemUsername" : "..." } }

Element loginTestRequest

Request wrapper object that contains the ldap login test details.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <loginTestRequest> <data> <!--content of type 'ldapServerLoginTest'--> <configuration> <!--content of type 'ldapServerConfiguration'--> <connectionInfo> <!--content of type 'ldapConnectionInfo'--> <authScheme> <!--content of type 'string'--> ... </authScheme> <backupMirrorHost> <!--content of type 'string'--> ... </backupMirrorHost> <backupMirrorPort> <!--content of type 'int'--> ... </backupMirrorPort> <backupMirrorProtocol> <!--content of type 'string'--> ... </backupMirrorProtocol> <cacheTimeout> <!--content of type 'int'--> ... </cacheTimeout> <connectionRetryDelay> <!--content of type 'int'--> ... </connectionRetryDelay> <connectionTimeout> <!--content of type 'int'--> ... </connectionTimeout> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <protocol> <!--content of type 'string'--> ... </protocol> <realm> <!--content of type 'string'--> ... </realm> <searchBase> <!--content of type 'string'--> ... </searchBase> <systemPassword> <!--content of type 'string'--> ... </systemPassword> <systemUsername> <!--content of type 'string'--> ... </systemUsername> </connectionInfo> <id> <!--content of type 'string'--> ... </id> <url> <!--content of type 'string'--> ... </url> <name> <!--content of type 'string'--> ... </name> <userAndGroupConfig> <!--content of type 'ldapUserAndGroupAuthConfiguration'--> <emailAddressAttribute> <!--content of type 'string'--> ... </emailAddressAttribute> <groupBaseDn> <!--content of type 'string'--> ... </groupBaseDn> <groupIdAttribute> <!--content of type 'string'--> ... </groupIdAttribute> <groupMemberAttribute> <!--content of type 'string'--> ... </groupMemberAttribute> <groupMemberFormat> <!--content of type 'string'--> ... </groupMemberFormat> <groupObjectClass> <!--content of type 'string'--> ... </groupObjectClass> <userBaseDn> <!--content of type 'string'--> ... </userBaseDn> <userIdAttribute> <!--content of type 'string'--> ... </userIdAttribute> <userMemberOfAttribute> <!--content of type 'string'--> ... </userMemberOfAttribute> <userObjectClass> <!--content of type 'string'--> ... </userObjectClass> <userPasswordAttribute> <!--content of type 'string'--> ... </userPasswordAttribute> <userRealNameAttribute> <!--content of type 'string'--> ... </userRealNameAttribute> <groupSubtree> <!--content of type 'boolean'--> ... </groupSubtree> <ldapGroupsAsRoles> <!--content of type 'boolean'--> ... </ldapGroupsAsRoles> <userSubtree> <!--content of type 'boolean'--> ... </userSubtree> <ldapFilter> <!--content of type 'string'--> ... </ldapFilter> </userAndGroupConfig> </configuration> <username> <!--content of type 'string'--> ... </username> <password> <!--content of type 'string'--> ... </password> </data> </loginTestRequest>

Example JSON

{ "data" : { "configuration" : { "connectionInfo" : { "authScheme" : "...", "backupMirrorHost" : "...", "backupMirrorPort" : ..., "backupMirrorProtocol" : "...", "cacheTimeout" : ..., "connectionRetryDelay" : ..., "connectionTimeout" : ..., "host" : "...", "port" : ..., "protocol" : "...", "realm" : "...", "searchBase" : "...", "systemPassword" : "...", "systemUsername" : "..." }, "id" : "...", "url" : "...", "name" : "...", "userAndGroupConfig" : { "emailAddressAttribute" : "...", "groupBaseDn" : "...", "groupIdAttribute" : "...", "groupMemberAttribute" : "...", "groupMemberFormat" : "...", "groupObjectClass" : "...", "userBaseDn" : "...", "userIdAttribute" : "...", "userMemberOfAttribute" : "...", "userObjectClass" : "...", "userPasswordAttribute" : "...", "userRealNameAttribute" : "...", "groupSubtree" : false, "ldapGroupsAsRoles" : false, "userSubtree" : false, "ldapFilter" : "..." } }, "username" : "...", "password" : "..." } }

Element orderRequest

Request wrapper object that contains the ordered list of ldap server ids.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <orderRequest> <data> <!--content of type 'string'--> ... </data> <data> <!--(another 'string' type)--> </data> <!--...more "data" elements...--> </orderRequest>

Example JSON

{ "data" : [ "...", ... ] }

Element server

Request wrapper for setting up an ldap server configuration.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <server> <data> <!--content of type 'ldapServerConfiguration'--> <connectionInfo> <!--content of type 'ldapConnectionInfo'--> <authScheme> <!--content of type 'string'--> ... </authScheme> <backupMirrorHost> <!--content of type 'string'--> ... </backupMirrorHost> <backupMirrorPort> <!--content of type 'int'--> ... </backupMirrorPort> <backupMirrorProtocol> <!--content of type 'string'--> ... </backupMirrorProtocol> <cacheTimeout> <!--content of type 'int'--> ... </cacheTimeout> <connectionRetryDelay> <!--content of type 'int'--> ... </connectionRetryDelay> <connectionTimeout> <!--content of type 'int'--> ... </connectionTimeout> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <protocol> <!--content of type 'string'--> ... </protocol> <realm> <!--content of type 'string'--> ... </realm> <searchBase> <!--content of type 'string'--> ... </searchBase> <systemPassword> <!--content of type 'string'--> ... </systemPassword> <systemUsername> <!--content of type 'string'--> ... </systemUsername> </connectionInfo> <id> <!--content of type 'string'--> ... </id> <url> <!--content of type 'string'--> ... </url> <name> <!--content of type 'string'--> ... </name> <userAndGroupConfig> <!--content of type 'ldapUserAndGroupAuthConfiguration'--> <emailAddressAttribute> <!--content of type 'string'--> ... </emailAddressAttribute> <groupBaseDn> <!--content of type 'string'--> ... </groupBaseDn> <groupIdAttribute> <!--content of type 'string'--> ... </groupIdAttribute> <groupMemberAttribute> <!--content of type 'string'--> ... </groupMemberAttribute> <groupMemberFormat> <!--content of type 'string'--> ... </groupMemberFormat> <groupObjectClass> <!--content of type 'string'--> ... </groupObjectClass> <userBaseDn> <!--content of type 'string'--> ... </userBaseDn> <userIdAttribute> <!--content of type 'string'--> ... </userIdAttribute> <userMemberOfAttribute> <!--content of type 'string'--> ... </userMemberOfAttribute> <userObjectClass> <!--content of type 'string'--> ... </userObjectClass> <userPasswordAttribute> <!--content of type 'string'--> ... </userPasswordAttribute> <userRealNameAttribute> <!--content of type 'string'--> ... </userRealNameAttribute> <groupSubtree> <!--content of type 'boolean'--> ... </groupSubtree> <ldapGroupsAsRoles> <!--content of type 'boolean'--> ... </ldapGroupsAsRoles> <userSubtree> <!--content of type 'boolean'--> ... </userSubtree> <ldapFilter> <!--content of type 'string'--> ... </ldapFilter> </userAndGroupConfig> </data> </server>

Example JSON

{ "data" : { "connectionInfo" : { "authScheme" : "...", "backupMirrorHost" : "...", "backupMirrorPort" : ..., "backupMirrorProtocol" : "...", "cacheTimeout" : ..., "connectionRetryDelay" : ..., "connectionTimeout" : ..., "host" : "...", "port" : ..., "protocol" : "...", "realm" : "...", "searchBase" : "...", "systemPassword" : "...", "systemUsername" : "..." }, "id" : "...", "url" : "...", "name" : "...", "userAndGroupConfig" : { "emailAddressAttribute" : "...", "groupBaseDn" : "...", "groupIdAttribute" : "...", "groupMemberAttribute" : "...", "groupMemberFormat" : "...", "groupObjectClass" : "...", "userBaseDn" : "...", "userIdAttribute" : "...", "userMemberOfAttribute" : "...", "userObjectClass" : "...", "userPasswordAttribute" : "...", "userRealNameAttribute" : "...", "groupSubtree" : false, "ldapGroupsAsRoles" : false, "userSubtree" : false, "ldapFilter" : "..." } } }

Element serverList

Response wrapper object that contains the list of ldap servers.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <serverList> <data> <ldapServerListEntry> <!--content of type 'ldapServerListEntry'--> <id> <!--content of type 'string'--> ... </id> <name> <!--content of type 'string'--> ... </name> <url> <!--content of type 'string'--> ... </url> <ldapUrl> <!--content of type 'string'--> ... </ldapUrl> </ldapServerListEntry> <ldapServerListEntry> <!--(another 'ldapServerListEntry' type)--> </ldapServerListEntry> <!--...more "ldapServerListEntry" elements...--> </data> </serverList>

Example JSON

{ "data" : [ { "id" : "...", "name" : "...", "url" : "...", "ldapUrl" : "..." }, ... ] }

Element templateList

Response wrapper object that contains the list of ldap schema templates

Example XML

<?xml version="1.0" encoding="UTF-8"?> <templateList> <data> <ldapSchemaTemplate> <!--content of type 'ldapSchemaTemplate'--> <name> <!--content of type 'string'--> ... </name> <userAndGroupConfig> <!--content of type 'ldapUserAndGroupAuthConfiguration'--> <emailAddressAttribute> <!--content of type 'string'--> ... </emailAddressAttribute> <groupBaseDn> <!--content of type 'string'--> ... </groupBaseDn> <groupIdAttribute> <!--content of type 'string'--> ... </groupIdAttribute> <groupMemberAttribute> <!--content of type 'string'--> ... </groupMemberAttribute> <groupMemberFormat> <!--content of type 'string'--> ... </groupMemberFormat> <groupObjectClass> <!--content of type 'string'--> ... </groupObjectClass> <userBaseDn> <!--content of type 'string'--> ... </userBaseDn> <userIdAttribute> <!--content of type 'string'--> ... </userIdAttribute> <userMemberOfAttribute> <!--content of type 'string'--> ... </userMemberOfAttribute> <userObjectClass> <!--content of type 'string'--> ... </userObjectClass> <userPasswordAttribute> <!--content of type 'string'--> ... </userPasswordAttribute> <userRealNameAttribute> <!--content of type 'string'--> ... </userRealNameAttribute> <groupSubtree> <!--content of type 'boolean'--> ... </groupSubtree> <ldapGroupsAsRoles> <!--content of type 'boolean'--> ... </ldapGroupsAsRoles> <userSubtree> <!--content of type 'boolean'--> ... </userSubtree> <ldapFilter> <!--content of type 'string'--> ... </ldapFilter> </userAndGroupConfig> </ldapSchemaTemplate> <ldapSchemaTemplate> <!--(another 'ldapSchemaTemplate' type)--> </ldapSchemaTemplate> <!--...more "ldapSchemaTemplate" elements...--> </data> </templateList>

Example JSON

{ "data" : [ { "name" : "...", "userAndGroupConfig" : { "emailAddressAttribute" : "...", "groupBaseDn" : "...", "groupIdAttribute" : "...", "groupMemberAttribute" : "...", "groupMemberFormat" : "...", "groupObjectClass" : "...", "userBaseDn" : "...", "userIdAttribute" : "...", "userMemberOfAttribute" : "...", "userObjectClass" : "...", "userPasswordAttribute" : "...", "userRealNameAttribute" : "...", "groupSubtree" : false, "ldapGroupsAsRoles" : false, "userSubtree" : false, "ldapFilter" : "..." } }, ... ] }

Element userList

Response wrapper that contains the list of ldap users.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <userList> <data> <ldapUser> <!--content of type 'ldapUser'--> <userId> <!--content of type 'string'--> ... </userId> <roles> <!--content of type 'string'--> ... </roles> <roles> <!--(another 'string' type)--> </roles> <!--...more "roles" elements...--> <name> <!--content of type 'string'--> ... </name> <email> <!--content of type 'string'--> ... </email> </ldapUser> <ldapUser> <!--(another 'ldapUser' type)--> </ldapUser> <!--...more "ldapUser" elements...--> </data> </userList>

Example JSON

{ "data" : [ { "userId" : "...", "roles" : [ "...", ... ], "name" : "...", "email" : "..." }, ... ] }

Type ldapAuthenticationTestRequest

Request wrapper object that contains the connection info

Child Elements

name (type) min/max
occurs
description
data (ldapConnectionInfo) 0/1 Get the ldap connection info.

Type ldapConnectionInfo

LDAP Connection Information.

Child Elements

name (type) min/max
occurs
description
authScheme (string) 0/1 Get authentication Scheme. Method used for authentication: none, simple, etc.
backupMirrorHost (string) 0/1 Get backup mirror host. The host name of the backup LDAP server.
backupMirrorPort (int) 1/1 Get backup mirror port. The port of the backup LDAP Server.
backupMirrorProtocol (string) 0/1 Get backup mirror protocol. The protocol used for the backup mirror URL: ldap, ldaps.
cacheTimeout (int) 1/1 Get cache timeout. Cache timeout in seconds.
connectionRetryDelay (int) 1/1 Get connection retry delay. Connection retry delay in seconds.
connectionTimeout (int) 1/1 Get connection timeout. Connection timeout in seconds.
host (string) 0/1 Get host. The host name of the LDAP server.
port (int) 1/1 Get port. The port of the LDAP Server.
protocol (string) 0/1 Get protocol. The protocol used in the ldap URL: ldap, ldaps.
realm (string) 0/1 Get sASL Realm. The authentication realm.
searchBase (string) 0/1 Get search Base. Base DN for the connection.
systemPassword (string) 0/1 Get system Password. The password for the System User.
systemUsername (string) 0/1 Get system User. The username of user with access to the LDAP server.

Type ldapSchemaTemplate

LDAP schema template object, contains defaults for a schema

Child Elements

name (type) min/max
occurs
description
name (string) 0/1 Get the name of the template.
userAndGroupConfig (ldapUserAndGroupAuthConfiguration) 0/1 Get the template configuration.

Type ldapSchemaTemplateListResponse

Response wrapper object that contains the list of ldap schema templates

Child Elements

name (type) min/max
occurs
description
ldapSchemaTemplate (ldapSchemaTemplate) 0/unbounded Get the list of ldap schema templates.

Type ldapServerConfiguration

Object that holds the configuration of each configured LDAP server.

Child Elements

name (type) min/max
occurs
description
connectionInfo (ldapConnectionInfo) 0/1 Get lDAP Connection Information.
id (string) 0/1 Get lDAP Connection Id.
url (string) 0/1 Get url.
name (string) 0/1 Get lDAP Connection Name.
userAndGroupConfig (ldapUserAndGroupAuthConfiguration) 0/1 Get the user and group mapping configuration mapping.

Type ldapServerListEntry

List entry of an ldap server.

Child Elements

name (type) min/max
occurs
description
id (string) 0/1 Get the id of the ldap server.
name (string) 0/1 Get the name of the ldap server.
url (string) 0/1 Get the url used to manage the ldap server in nexus.
ldapUrl (string) 0/1 Get the url used to access the remote ldap server.

Type ldapServerListResponse

Response wrapper object that contains the list of ldap servers.

Child Elements

name (type) min/max
occurs
description
ldapServerListEntry (ldapServerListEntry) 0/unbounded Get the list of ldap servers.

Type ldapServerLoginTest

Ldap Server login test parameters.

Child Elements

name (type) min/max
occurs
description
configuration (ldapServerConfiguration) 0/1 Get the ldap server configuration.
username (string) 0/1 Get the username to test.
password (string) 0/1 Get the password to test.

Type ldapServerLoginTestRequest

Request wrapper object that contains the ldap login test details.

Child Elements

name (type) min/max
occurs
description
data (ldapServerLoginTest) 0/1 Get the ldap login test object.

Type ldapServerOrderRequest

Request wrapper object that contains the ordered list of ldap server ids.

Child Elements

name (type) min/max
occurs
description
data (string) 0/unbounded Get the ordered list of LDAP server ids.

Type ldapServerRequest

Request wrapper for setting up an ldap server configuration.

Child Elements

name (type) min/max
occurs
description
data (ldapServerConfiguration) 0/1 Get the ldap server configuration object.

Type ldapUser

Ldap User details.

Child Elements

name (type) min/max
occurs
description
userId (string) 0/1 (no documentation provided)
roles (string) 0/unbounded (no documentation provided)
name (string) 0/1 (no documentation provided)
email (string) 0/1 (no documentation provided)

Type ldapUserAndGroupAuthConfiguration

The user and group mapping configuration mapping.

Child Elements

name (type) min/max
occurs
description
emailAddressAttribute (string) 0/1 Get email Address Attribute. The attribute that stores the users email address.
groupBaseDn (string) 0/1 Get group Base DN. The base DN that defines Groups.
groupIdAttribute (string) 0/1 Get group Id Attribute. The ID attribute for the Group.
groupMemberAttribute (string) 0/1 Get group Member Attribute, An attribute that defines the a user is a member of the group.
groupMemberFormat (string) 0/1 Get group Member Format. The format that the user info is stored in the groupMappingsAttribute. Such as ${username}, or uid=${username},ou=people,o=yourBiz. ${username} will be replaced with the username.
groupObjectClass (string) 0/1 Get group Object Class. The Object class used for groups.
userBaseDn (string) 0/1 Get user Base DN. The base DN for the users.
userIdAttribute (string) 0/1 Get user Id Attribute. THe attribute of the userId field.
userMemberOfAttribute (string) 0/1 Get groups are generally one of two types in LDAP systems - static or dynamic. A static group maintains its own membership list. A dynamic group records its membership on a user entry. If dynamic groups this should be set to the attribute used to store the group string in the user object.
userObjectClass (string) 0/1 Get user Object Class. The object class used for users.
userPasswordAttribute (string) 0/1 Get user Password Attribute. The attribute that stores the users password.
userRealNameAttribute (string) 0/1 Get user Real Name Attribute. The attribute that defines the users real name.
groupSubtree (boolean) 1/1 Get groups are Stored in a subtree of the groupBaseDn.
ldapGroupsAsRoles (boolean) 1/1 Get use LDAP groups as roles. True if LDAP groups should be used as roles.
userSubtree (boolean) 1/1 Get users are Stored in a subtree of the userBaseDn.
ldapFilter (string) 0/1 Return the filter expression added to the user search.

Example: (&(mail=*@domain.com)(uid=user_*)

Type ldapUserListResponse

Response wrapper that contains the list of ldap users.

Child Elements

name (type) min/max
occurs
description
ldapUser (ldapUser) 0/unbounded Get the list of ldap user objects.