Sonatype Nexus OSS 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 connectionInfo

Example XML

<?xml version="1.0" encoding="UTF-8"?> <connectionInfo> <data> <!--content of type 'ldapConnectionInfoDTO'--> <searchBase> <!--content of type 'string'--> ... </searchBase> <systemUsername> <!--content of type 'string'--> ... </systemUsername> <systemPassword> <!--content of type 'string'--> ... </systemPassword> <authScheme> <!--content of type 'string'--> ... </authScheme> <protocol> <!--content of type 'string'--> ... </protocol> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <realm> <!--content of type 'string'--> ... </realm> </data> </connectionInfo>

Example JSON

{ "data" : { "searchBase" : "...", "systemUsername" : "...", "systemPassword" : "...", "authScheme" : "...", "protocol" : "...", "host" : "...", "port" : ..., "realm" : "..." } }

Element connectionInfoTest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <connectionInfoTest> <data> <!--content of type 'ldapConnectionInfoDTO'--> <searchBase> <!--content of type 'string'--> ... </searchBase> <systemUsername> <!--content of type 'string'--> ... </systemUsername> <systemPassword> <!--content of type 'string'--> ... </systemPassword> <authScheme> <!--content of type 'string'--> ... </authScheme> <protocol> <!--content of type 'string'--> ... </protocol> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <realm> <!--content of type 'string'--> ... </realm> </data> </connectionInfoTest>

Example JSON

{ "data" : { "searchBase" : "...", "systemUsername" : "...", "systemPassword" : "...", "authScheme" : "...", "protocol" : "...", "host" : "...", "port" : ..., "realm" : "..." } }

Element userAndGroupConfig

Example XML

<?xml version="1.0" encoding="UTF-8"?> <userAndGroupConfig> <data> <!--content of type 'ldapUserAndGroupConfigurationDTO'--> <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> <userPasswordAttribute> <!--content of type 'string'--> ... </userPasswordAttribute> <userIdAttribute> <!--content of type 'string'--> ... </userIdAttribute> <userObjectClass> <!--content of type 'string'--> ... </userObjectClass> <userBaseDn> <!--content of type 'string'--> ... </userBaseDn> <userRealNameAttribute> <!--content of type 'string'--> ... </userRealNameAttribute> <ldapGroupsAsRoles> <!--content of type 'boolean'--> ... </ldapGroupsAsRoles> <userSubtree> <!--content of type 'boolean'--> ... </userSubtree> <groupSubtree> <!--content of type 'boolean'--> ... </groupSubtree> <userMemberOfAttribute> <!--content of type 'string'--> ... </userMemberOfAttribute> </data> </userAndGroupConfig>

Example JSON

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

Element userAndGroupConfigTest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <userAndGroupConfigTest> <data> <!--content of type 'ldapUserAndGroupConfigTestRequestDTO'--> <searchBase> <!--content of type 'string'--> ... </searchBase> <systemUsername> <!--content of type 'string'--> ... </systemUsername> <systemPassword> <!--content of type 'string'--> ... </systemPassword> <authScheme> <!--content of type 'string'--> ... </authScheme> <protocol> <!--content of type 'string'--> ... </protocol> <host> <!--content of type 'string'--> ... </host> <port> <!--content of type 'int'--> ... </port> <realm> <!--content of type 'string'--> ... </realm> <userLimitCount> <!--content of type 'int'--> ... </userLimitCount> </data> </userAndGroupConfigTest>

Example JSON

{ "data" : { "searchBase" : "...", "systemUsername" : "...", "systemPassword" : "...", "authScheme" : "...", "protocol" : "...", "host" : "...", "port" : ..., "realm" : "...", "userLimitCount" : ... } }

Element userList

Example XML

<?xml version="1.0" encoding="UTF-8"?> <userList> <data> <user> <!--content of type 'user'--> <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> </user> <user> <!--(another 'user' type)--> </user> <!--...more "user" elements...--> </data> </userList>

Example JSON

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

Type ldapAuthenticationTestRequest

Child Elements

name (type) min/max
occurs
description
data (ldapConnectionInfoDTO) 0/1 (no documentation provided)

Type ldapConnectionInfoDTO

Child Elements

name (type) min/max
occurs
description
searchBase (string) 0/1 (no documentation provided)
systemUsername (string) 0/1 (no documentation provided)
systemPassword (string) 0/1 (no documentation provided)
authScheme (string) 0/1 (no documentation provided)
protocol (string) 0/1 (no documentation provided)
host (string) 0/1 (no documentation provided)
port (int) 1/1 (no documentation provided)
realm (string) 0/1 (no documentation provided)

Type ldapConnectionInfoResponse

Child Elements

name (type) min/max
occurs
description
data (ldapConnectionInfoDTO) 0/1 (no documentation provided)

Type ldapUserAndGroupConfigTestRequest

Child Elements

name (type) min/max
occurs
description
data (ldapUserAndGroupConfigTestRequestDTO) 0/1 (no documentation provided)

Type ldapUserAndGroupConfigTestRequestDTO

Child Elements

name (type) min/max
occurs
description
searchBase (string) 0/1 (no documentation provided)
systemUsername (string) 0/1 (no documentation provided)
systemPassword (string) 0/1 (no documentation provided)
authScheme (string) 0/1 (no documentation provided)
protocol (string) 0/1 (no documentation provided)
host (string) 0/1 (no documentation provided)
port (int) 1/1 (no documentation provided)
realm (string) 0/1 (no documentation provided)
userLimitCount (int) 1/1 (no documentation provided)

Type ldapUserAndGroupConfigurationDTO

Child Elements

name (type) min/max
occurs
description
emailAddressAttribute (string) 0/1 (no documentation provided)
groupBaseDn (string) 0/1 (no documentation provided)
groupIdAttribute (string) 0/1 (no documentation provided)
groupMemberAttribute (string) 0/1 (no documentation provided)
groupMemberFormat (string) 0/1 (no documentation provided)
groupObjectClass (string) 0/1 (no documentation provided)
userPasswordAttribute (string) 0/1 (no documentation provided)
userIdAttribute (string) 0/1 (no documentation provided)
userObjectClass (string) 0/1 (no documentation provided)
userBaseDn (string) 0/1 (no documentation provided)
userRealNameAttribute (string) 0/1 (no documentation provided)
ldapGroupsAsRoles (boolean) 1/1 (no documentation provided)
userSubtree (boolean) 1/1 (no documentation provided)
groupSubtree (boolean) 1/1 (no documentation provided)
userMemberOfAttribute (string) 0/1 (no documentation provided)

Type ldapUserAndGroupConfigurationResponse

Child Elements

name (type) min/max
occurs
description
data (ldapUserAndGroupConfigurationDTO) 0/1 (no documentation provided)

Type ldapUserListResponse

Child Elements

name (type) min/max
occurs
description
user (user) 0/unbounded (no documentation provided)

Type user

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)