Sonatype Security REST 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 role-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <role-request> <data> <!--content of type 'roleResource'--> <name> <!--content of type 'string'--> ... </name> <sessionTimeout> <!--content of type 'int'--> ... </sessionTimeout> <privileges> <!--content of type 'string'--> ... </privileges> <privileges> <!--(another 'string' type)--> </privileges> <!--...more "privileges" elements...--> <roles> <role> <!--content of type 'string'--> ... </role> <role> <!--(another 'string' type)--> </role> <!--...more "role" elements...--> </roles> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <description> <!--content of type 'string'--> ... </description> <userManaged> <!--content of type 'boolean'--> ... </userManaged> <id> <!--content of type 'string'--> ... </id> </data> </role-request>

Example JSON

{ "data" : { "name" : "...", "sessionTimeout" : ..., "privileges" : [ "...", ... ], "roles" : [ "...", ... ], "resourceURI" : "...", "description" : "...", "userManaged" : false, "id" : "..." } }

Element roles-privs-list-filter

Example XML

<?xml version="1.0" encoding="UTF-8"?> <roles-privs-list-filter> <role-priv-list-filter> <!--content of type 'roleAndPrivilegeListFilterResource'--> <noPrivileges> <!--content of type 'boolean'--> ... </noPrivileges> <hiddenPrivilegeIds> <hiddenPrivilegeId> <!--content of type 'string'--> ... </hiddenPrivilegeId> <hiddenPrivilegeId> <!--(another 'string' type)--> </hiddenPrivilegeId> <!--...more "hiddenPrivilegeId" elements...--> </hiddenPrivilegeIds> <selctedPrivilegeIds> <selectedPrivilegeId> <!--content of type 'string'--> ... </selectedPrivilegeId> <selectedPrivilegeId> <!--(another 'string' type)--> </selectedPrivilegeId> <!--...more "selectedPrivilegeId" elements...--> </selctedPrivilegeIds> <name> <!--content of type 'string'--> ... </name> <userId> <!--content of type 'string'--> ... </userId> <noRoles> <!--content of type 'boolean'--> ... </noRoles> <noExternalRoles> <!--content of type 'boolean'--> ... </noExternalRoles> <hiddenRoleIds> <hiddenRoleId> <!--content of type 'string'--> ... </hiddenRoleId> <hiddenRoleId> <!--(another 'string' type)--> </hiddenRoleId> <!--...more "hiddenRoleId" elements...--> </hiddenRoleIds> <selctedRoleIds> <selectedRoleId> <!--content of type 'string'--> ... </selectedRoleId> <selectedRoleId> <!--(another 'string' type)--> </selectedRoleId> <!--...more "selectedRoleId" elements...--> </selctedRoleIds> <onlySelected> <!--content of type 'boolean'--> ... </onlySelected> </role-priv-list-filter> </roles-privs-list-filter>

Example JSON

{ "role-priv-list-filter" : { "noPrivileges" : false, "hiddenPrivilegeIds" : [ "...", ... ], "selctedPrivilegeIds" : [ "...", ... ], "name" : "...", "userId" : "...", "noRoles" : false, "noExternalRoles" : false, "hiddenRoleIds" : [ "...", ... ], "selctedRoleIds" : [ "...", ... ], "onlySelected" : false } }

Element user-changepw

Example XML

<?xml version="1.0" encoding="UTF-8"?> <user-changepw> <data> <!--content of type 'userChangePasswordResource'--> <oldPassword> <!--content of type 'string'--> ... </oldPassword> <userId> <!--content of type 'string'--> ... </userId> <newPassword> <!--content of type 'string'--> ... </newPassword> </data> </user-changepw>

Example JSON

{ "data" : { "oldPassword" : "...", "userId" : "...", "newPassword" : "..." } }

Element user-forgotpw

Example XML

<?xml version="1.0" encoding="UTF-8"?> <user-forgotpw> <data> <!--content of type 'userForgotPasswordResource'--> <email> <!--content of type 'string'--> ... </email> <userId> <!--content of type 'string'--> ... </userId> </data> </user-forgotpw>

Example JSON

{ "data" : { "email" : "...", "userId" : "..." } }

Element user-request

Example XML

<?xml version="1.0" encoding="UTF-8"?> <user-request> <data> <!--content of type 'userResource'--> <firstName> <!--content of type 'string'--> ... </firstName> <lastName> <!--content of type 'string'--> ... </lastName> <status> <!--content of type 'string'--> ... </status> <userId> <!--content of type 'string'--> ... </userId> <resourceURI> <!--content of type 'string'--> ... </resourceURI> <email> <!--content of type 'string'--> ... </email> <password> <!--content of type 'string'--> ... </password> <roles> <role> <!--content of type 'string'--> ... </role> <role> <!--(another 'string' type)--> </role> <!--...more "role" elements...--> </roles> </data> </user-request>

Example JSON

{ "data" : { "firstName" : "...", "lastName" : "...", "status" : "...", "userId" : "...", "resourceURI" : "...", "email" : "...", "password" : "...", "roles" : [ "...", ... ] } }

Element user-search

Example XML

<?xml version="1.0" encoding="UTF-8"?> <user-search> <data> <!--content of type 'plexusUserSearchCriteriaResource'--> <userId> <!--content of type 'string'--> ... </userId> <effectiveUsers> <!--content of type 'boolean'--> ... </effectiveUsers> </data> </user-search>

Example JSON

{ "data" : { "userId" : "...", "effectiveUsers" : false } }

Element user-to-role

Example XML

<?xml version="1.0" encoding="UTF-8"?> <user-to-role> <data> <!--content of type 'userToRoleResource'--> <userId> <!--content of type 'string'--> ... </userId> <source> <!--content of type 'string'--> ... </source> <roles> <role> <!--content of type 'string'--> ... </role> <role> <!--(another 'string' type)--> </role> <!--...more "role" elements...--> </roles> </data> </user-to-role>

Example JSON

{ "data" : { "userId" : "...", "source" : "...", "roles" : [ "...", ... ] } }

Type plexusUserSearchCriteriaResource

Child Elements

name (type) min/max
occurs
description
userId (string) 0/1 (no documentation provided)
effectiveUsers (boolean) 1/1 (no documentation provided)

Type plexusUserSearchCriteriaResourceRequest

Child Elements

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

Type roleAndPrivilegeListFilterResource

Child Elements

name (type) min/max
occurs
description
noPrivileges (boolean) 1/1 (no documentation provided)
hiddenPrivilegeId (string) 0/unbounded (no documentation provided)
selectedPrivilegeId (string) 0/unbounded (no documentation provided)
name (string) 0/1 (no documentation provided)
userId (string) 0/1 (no documentation provided)
noRoles (boolean) 1/1 (no documentation provided)
noExternalRoles (boolean) 1/1 (no documentation provided)
hiddenRoleId (string) 0/unbounded (no documentation provided)
selectedRoleId (string) 0/unbounded (no documentation provided)
onlySelected (boolean) 1/1 (no documentation provided)

Type roleAndPrivilegeListFilterResourceRequest

Child Elements

name (type) min/max
occurs
description
role-priv-list-filter (roleAndPrivilegeListFilterResource) 0/1 (no documentation provided)

Type roleResource

Child Elements

name (type) min/max
occurs
description
name (string) 0/1 (no documentation provided)
sessionTimeout (int) 1/1 (no documentation provided)
privileges (string) 0/unbounded (no documentation provided)
role (string) 0/unbounded (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
description (string) 0/1 (no documentation provided)
userManaged (boolean) 1/1 (no documentation provided)
id (string) 0/1 (no documentation provided)

Type roleResourceRequest

Child Elements

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

Type userChangePasswordRequest

Child Elements

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

Type userChangePasswordResource

Child Elements

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

Type userForgotPasswordRequest

Child Elements

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

Type userForgotPasswordResource

Child Elements

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

Type userResource

Child Elements

name (type) min/max
occurs
description
firstName (string) 0/1 (no documentation provided)
lastName (string) 0/1 (no documentation provided)
status (string) 0/1 (no documentation provided)
userId (string) 0/1 (no documentation provided)
resourceURI (string) 0/1 (no documentation provided)
email (string) 0/1 (no documentation provided)
password (string) 0/1 (no documentation provided)
role (string) 0/unbounded (no documentation provided)

Type userResourceRequest

Child Elements

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

Type userToRoleResource

Child Elements

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

Type userToRoleResourceRequest

Child Elements

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