pp108 : GetRoles

GetRoles

This API is used to retrieve the roles available in an organization.

SOAP Request

You can invoke the request in multiple forms, as mentioned in the below code snippets.

<GetRoles xmlns="http://schemas.cordys.com/UserManagement/1.0/User" />
</GetRoles>

The request contains Prefix.

<GetRoles xmlns="http://schemas.cordys.com/UserManagement/1.0/User">
    <Prefix>a</Prefix>
    <IncludeApplicationRoles>true</IncludeApplicationRoles>
</GetRoles>

The request contains Filter.

<GetRoles xmlns="http://schemas.cordys.com/UserManagement/1.0/User">
    <Filter>admin</Filter>
    <IncludeApplicationRoles>false</IncludeApplicationRoles>
</GetRoles>

The request contains Type.

<GetRoles xmlns="http://schemas.cordys.com/UserManagement/1.0/User">
    <Type>Internal</Type>
    <IncludeApplicationRoles>false</IncludeApplicationRoles>
</GetRoles>
Request Parameters

Parameter

Description

Data Type

Accepted Input Values

Prefix

Specifies the letters with which the role name starts

String

-

Filter

Contains the letters of the role name

String

-

Type

Specifies the type of roles

String
  • Internal
  • Application
  • Functional

IncludeApplicationRoles

Specifies whether the application (application package) roles must be searched or not

String
  • true - to include application roles
  • false - to exclude application roles. This is the default value.

SOAP Response

<GetRolesResponse
    xmlns="http://schemas.cordys.com/UserManagement/1.0/User" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <Role organization="system">systemAdmin</Role>
    <Role application="Cordys@Work">Administrator</Role>
    <Role application="Business Process Engine">Process Administrator</Role>
    <Role application="Business Activity Monitoring">BAM Administrator</Role>
</GetRolesResponse>
Response Parameters

Parameter

Description

Roles

Specifies the roles in an organization