AdminApi

All URIs are relative to http://localhost

Method	HTTP request	Description
addRole	PUT /admin/roles	Add Role
addUser	PUT /admin/users	Add User
deleteRole	DELETE /admin/roles/	Delete Role
deleteUser	DELETE /admin/users/	Delete User
getRole	GET /admin/roles/	Get Role
getUser	GET /admin/users/	UserProfile for userId
gnerateNewApiKeyForUser	PATCH /admin/users/{userId}/apikey	Update ApiKey
listRoles	GET /admin/roles	List Roles
listUsers	GET /admin/users	List Users
updatePasswordForUser	PATCH /admin/users/{userId}/password	Update Password
updateRole	PATCH /admin/roles/	Update Role
updateRolesForUser	PATCH /admin/users/{userId}/roles	Update User Roles

addRole

Role addRole(Role)

Add Role

Add a new Role

Parameters

Name	Type	Description	Notes
Role	Role

Return type

Role

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

addUser

UserProfile addUser(UserInformation)

Add User

Add a new User

Parameters

Name	Type	Description	Notes
UserInformation	UserInformation

Return type

UserProfile

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

deleteRole

JsonValue_Boolean deleteRole(roleName)

Delete Role

Delete Role

Parameters

Name	Type	Description	Notes
roleName	String	RoleKey	[default to null]

Return type

JsonValue_Boolean

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteUser

JsonValue_Boolean deleteUser(userId)

Delete User

Delete User

Parameters

Name	Type	Description	Notes
userId	String	UserId to Delete	[default to null]

Return type

JsonValue_Boolean

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRole

Role getRole(roleName)

Get Role

Get Role by RoleKey

Parameters

Name	Type	Description	Notes
roleName	String	RoleKey to search	[default to null]

Return type

Role

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUser

UserProfile getUser(userId)

UserProfile for userId

Get UserProfile for user

Parameters

Name	Type	Description	Notes
userId	String	UserId to search	[default to null]

Return type

UserProfile

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

gnerateNewApiKeyForUser

JsonValue_String gnerateNewApiKeyForUser(userId)

Update ApiKey

Generate an new APIkey for the user

Parameters

Name	Type	Description	Notes
userId	String	UserId to Update	[default to null]

Return type

JsonValue_String

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listRoles

List listRoles(filter, rowsPerPage, page)

List Roles

List all Roles or filtered

Parameters

Name	Type	Description	Notes
filter	String	filter after userId by contains	[optional] [default to null]
rowsPerPage	Long	Count elements per page	[optional] [default to null]
page	Long	Requested page of the ResultSets	[optional] [default to null]

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

listUsers

List listUsers(filter, rowsPerPage, page)

List Users

List all Users or filtered

Parameters

Name	Type	Description	Notes
filter	String	filter after userId by contains	[optional] [default to null]
rowsPerPage	Long	Count elements per page	[optional] [default to null]
page	Long	Requested page of the ResultSets	[optional] [default to null]

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

updatePasswordForUser

JsonValue_Boolean updatePasswordForUser(userId, PasswordUpdateRequest)

Update Password

Change Password of User

Parameters

Name	Type	Description	Notes
userId	String	UserId to Update	[default to null]
PasswordUpdateRequest	PasswordUpdateRequest

Return type

JsonValue_Boolean

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

updateRole

Role updateRole(roleName, UpdateRoleRequest)

Update Role

Update Role

Parameters

Name	Type	Description	Notes
roleName	String	RoleKey	[default to null]
UpdateRoleRequest	UpdateRoleRequest

Return type

Role

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

updateRolesForUser

UserProfile updateRolesForUser(userId, request_body)

Update User Roles

Update Roles of User

Parameters

Name	Type	Description	Notes
userId	String	UserId to Update	[default to null]
request_body	List		[optional]

Return type

UserProfile

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain