Sonatype Nexus User Account 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 captchaResponse

Example XML

<?xml version="1.0" encoding="UTF-8"?> <captchaResponse> <data> <!--content of type 'captcha'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <key> <!--content of type 'string'--> ... </key> </data> </captchaResponse>

Example JSON

{ "data" : { "resourceURI" : "...", "key" : "..." } }

Element signUpRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <signUpRequest> <userAccount> <!--content of type 'signUpUserAccount'--> <password> <!--content of type 'string'--> ... </password> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <oldPassword> <!--content of type 'string'--> ... </oldPassword> </userAccount> <captcha> <!--content of type 'captcha'--> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <key> <!--content of type 'string'--> ... </key> </captcha> </signUpRequest>

Example JSON

{ "userAccount" : { "password" : "...", "resourceURI" : "...", "oldPassword" : "..." }, "captcha" : { "resourceURI" : "...", "key" : "..." } }

Element signUpUserAccountRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <signUpUserAccountRequest> <data> <!--content of type 'signUpUserAccount'--> <password> <!--content of type 'string'--> ... </password> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <oldPassword> <!--content of type 'string'--> ... </oldPassword> </data> </signUpUserAccountRequest>

Example JSON

{ "data" : { "password" : "...", "resourceURI" : "...", "oldPassword" : "..." } }

Element userAccountDefaultRolesRequest

Example XML

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

Example JSON

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

Element userAccountDefaultRolesResponse

Example XML

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

Example JSON

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

Element userAccountStatusRequest

Example XML

<?xml version="1.0" encoding="UTF-8"?> <userAccountStatusRequest> <data> <!--content of type 'userAccountStatus'--> <enabled> <!--content of type 'boolean'--> ... </enabled> </data> </userAccountStatusRequest>

Example JSON

{ "data" : { "enabled" : false } }

Element userAccountStatusResponse

Example XML

<?xml version="1.0" encoding="UTF-8"?> <userAccountStatusResponse> <data> <!--content of type 'userAccountStatus'--> <enabled> <!--content of type 'boolean'--> ... </enabled> </data> </userAccountStatusResponse>

Example JSON

{ "data" : { "enabled" : false } }

Type captcha

Child Elements

name (type) min/max
occurs
description
resourceURI (string) 0/1 (no documentation provided)
key (string) 0/1 (no documentation provided)

Type captchaResponseDTO

Child Elements

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

Type signUpRequestDTO

Child Elements

name (type) min/max
occurs
description
userAccount (signUpUserAccount) 0/1 (no documentation provided)
captcha (captcha) 0/1 (no documentation provided)

Type signUpUserAccount

Child Elements

name (type) min/max
occurs
description
password (string) 0/1 (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
oldPassword (string) 0/1 (no documentation provided)

Type signUpUserAccountWrapperDTO

Child Elements

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

Type userAccount

Child Elements

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

Type userAccountDefaultRolesRequestDTO

Child Elements

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

Type userAccountDefaultRolesResponseDTO

Child Elements

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

Type userAccountStatus

Child Elements

name (type) min/max
occurs
description
enabled (boolean) 1/1 (no documentation provided)

Type userAccountStatusRequestDTO

Child Elements

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

Type userAccountStatusResponseDTO

Child Elements

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