RetrieveUserPrivileges Function

Retrieves the privileges a system user (user) has through their roles, and inherited privileges from their team membership.

Bound entities

Bound functions are invoked by appending the fully qualified function name to the URI representing an entity or collection.

Entity Type Binding Type
systemuser entity

Return type

Type Nullable Description
RetrieveUserPrivilegesResponse False Contains the response of the RetrieveUserPrivileges function.

Remarks

For privileges that the user inherits through their team membership, this function only returns the Basic (user-level) depth, regardless of the actual depth granted by the team's security roles. Privileges that come from the user's directly assigned security roles are returned at their actual depth.

If you need the user's effective privilege depth, including the full depth of privileges inherited from team roles, use one of these messages instead:

More information: Check a user's security privileges

See also