Operation
post /data/plat/usermgt/createuser
createPerson (createPerson : /data/plat/usermgt/createuser)
createPerson
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
delete /data/plat/usermgt/deleteuser/{id}
deletePerson (deletePerson : /data/plat/usermgt/deleteuser/{id})
deletePerson
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/plat/usermgt/reload
getAllPersons (getAllPersons : /data/plat/usermgt/reload)
getAllPersons
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DefinedUser]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/plat/usermgt/users/{id}
getSinglePerson (getSinglePerson : /data/plat/usermgt/users/{id})
getSinglePerson
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DefinedUser]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/plat/usermgt/users
getallusers (getallusers : /data/plat/usermgt/users)
getallusers
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DefinedUser]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/plat/usermgt/search/{name}
search (search : /data/plat/usermgt/search/{name})
search
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
name | required | name | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DefinedUser]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
post /data/plat/usermgt/setpassword
setpassword (setpassword : /data/plat/usermgt/setpassword)
setpassword
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
post /data/plat/usermgt/updateuser
updatePerson (updatePerson : /data/plat/usermgt/updateuser)
updatePerson
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
DefinedUser
Name |
Type |
Description |
Enum |
---|---|---|---|
ObjectId | Integer integer |
--- | --- |
EventType | String string |
--- | --- |
ClassType | String string |
--- | --- |
IdClass | Integer integer |
--- | --- |
userPassword | array[String] string |
--- | --- |
almapPwdLocked | String string |
--- | --- |
almapPwdReset | String string |
--- | --- |
telephoneNumber | String string |
--- | --- |
loginShell | String string |
--- | --- |
gidNumber | String string |
--- | --- |
uidNumber | String string |
--- | --- |
uid | String string |
--- | --- |
homeDirectory | String string |
--- | --- |
almapOsprofiles | String string |
--- | --- |
almapPwdHistory | String string |
--- | --- |
sn | String string |
--- | --- |
cn | String string |
--- | --- |
distinguishedName | String string |
--- | --- |
name | String string |
--- | --- |
displayName | String string |
--- | --- |
listId | Integer integer |
--- | --- |
radiusRole | String string |
--- | --- |
base | String string |
--- | --- |
sAMAccountName | String string |
--- | --- |
userPrincipalName | String string |
--- | --- |
primaryGroupID | String string |
--- | --- |
userAccountControl | String string |
--- | --- |
id | Integer integer |
--- | --- |
extLDAPSuffixDC | String string |
--- | --- |
extLDAPPort | String string |
--- | --- |
userAuthType | String string |
--- | --- |
extLDAPHostname | String string |
--- | --- |
memberOf | array[String] string |
--- | --- |