N-central Help

Get Security Role Information

Get information on specified Security Role.

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 Security Role to get information on.

Output Parameters

Name Type Description
Security Roles Count Number Number of Security roles within the array.
Description String Description of the Security Role.
Name String Name of the Security Role.
Is System String Displays if the Security Role is a System type or not.
Is Enabled String Displays is the Security Group is enabled or not.
Object ID String Object ID of Security 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>
Role Name String Yes Company Administrator