ecm.security

The ecm.security namespace provides access to user and group information on the ECM server, plus write operations for the user lifecycle and group memberships.

1. Read methods

Method Description

roles()

Returns the system roles of a user.

users()

Returns the list of all users.

user()

Returns the details of a single user.

groups()

Returns all groups.

group()

Returns the attributes of a single group.

group_members()

Returns the members of a group.

user_groups()

Returns the groups of a user.

check_password_complexity()

Checks a password against the server’s password rule (not a credential check).

check_user_account()

Checks an account’s login name and password including lock and expiry state (needs the SERVER_SWITCH_JOB_CONTEXT system role).

2. Write methods

Method Description

create_user()

Creates a new user.

update_user()

Updates the attributes of a user.

delete_user()

Deletes a user.

add_user_to_group()

Adds a user to a group.

remove_user_from_group()

Removes a user from a group (or from all groups).

create_group()

Creates a new group.

update_group()

Updates the attributes of a group.

delete_group()

Deletes a group.

empty_group()

Removes all members of a group.

export_security_system()

Exports the permission clauses and rights bit fields per group.