SecurityResource

The following resources are part of this group:

/security/addRole

POST

Request Body

element: role
media types: */*
application/xml

(no documentation provided)

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/addUser

POST

Adds a user in the Flux engine. The group of an existing user cannot be changed. The caller must have administrator privileges, unless the caller is modifying its own user object, in which case any user property may be updated except the username. Any lock held on the specified user is released automatically.

Usernames and role names must be unique within a group.

Parameters

name description type default
username A unique identifier for this user. form
password The user's password. form
displayName The user's full display name. form
role The user's role. form

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/encryptPassword

GET

Parameters

name description type default
password (no documentation provided) query

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/getRole

GET

Parameters

name description type default
roleName (no documentation provided) query

Response Body

element: (custom)
media types: application/json

(no documentation provided)

/security/modifyRole

POST

Request Body

element: role
media types: */*
application/xml

(no documentation provided)

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/modifyUser

POST

Updates a user in the Flux engine. The group of an existing user cannot be changed. The caller must have administrator privileges, unless the caller is modifying its own user object, in which case any user property may be updated except the username. Any lock held on the specified user is released automatically.

Usernames and role names must be unique within a group.

Parameters

name description type default
username A unique identifier for this user. form
password The user's password. form
displayName The user's full display name. form
role The user's role. form

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/removeRole

POST

Parameters

name description type default
roleName (no documentation provided) form

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/removeUser

POST

Deletes the specified user from the Flux engine. If the user is referenced in a business process trigger, a run-as-user flow chart property, or a run-as-user runtime configuration property, the user cannot be deleted. The caller must have administrator privileges.

Parameters

name description type default
username The name of the user to delete. form

Response Body

element: (custom)
media types: */*
application/xml

Whether the specified user was deleted.

/security/renameRole

POST

Parameters

name description type default
oldName (no documentation provided) form
newName (no documentation provided) form

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

/security/roles

GET

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

/security/users

GET

Returns all users sorted by username. A username is case-insensitive. The caller must have administrator privileges.

Response Body

element: (custom)
media types: */*
application/xml

All users sorted by username.