N-central Help

Get Security Role Membership for User

Get the Security Role membership for a specified user.

Input Parameters

Name Type Required Description
User Name String Yes User name used to authenticate to the Office 365 web service.
Password Password Yes Password used to authenticate to the Office 365 web service.
Role Name String Yes Name of the Role to get the memberships of.
Email Address String Yes Email address of user to determine if is a member of Role.

Output Parameters

Name Type Description
Role List Count Number Number of Roles with members returned within array.
Description String Description Roles that have members.
Name String Name of the Role.
Is System String Displays if the Role is a system Role or not.
Is Enabled String Displays if the Role is an enabled Role or not.
Object ID String The ID of the Role.
Result String String In the event the object fails to execute successfully due to invalid/incorrect input, this output will detail the error.
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
User Name String Yes Office365Admin@ABC.onmicrosoft.com
Password Password Yes <link to start parameter>
Roles Boolean Yes
  • All Roles will retrieve the user membership of all existing Roles. With this option selected the “Role Name” field is not used.
  • One Role will retrieve the user membership for the role specified within the “Role Name” field.
Role Name String Yes Marketing
Email Address String Yes User1@ABC.onmicrosoft.com