ARGetListRole

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves a list of roles for a deployable application or returns a list of roles for a user for a deployable application.

Privileges

Role information for the current user can be retrieved by all users. Access to role information for other users is limited to users with administrator privileges.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetListRole(
ARControlStruct *control,
  ARNameType applicationName,
  ARAccessNameType userName,
  ARAccessNameType password,
  ARRoleInfoList *roleList,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

applicationName

The name of the specific application to get roles from.

userName

The name of the specific user for which the system retrieves roles information. Specify NULL to retrieve all roles for the application.

password

The password of the specific user for whom the system retrieves the list. If this parameter is NULL, the function returns the role list for the first user whose name matches the name passed in, not necessarily the user who requested the list. If this parameter specifies a password, the server returns the role list for the user whose name and password match those in the parameter list.

Return values

roleList

A list of zero or more roles that match the criteria defined by the userName parameter. Each item in the list contains a role ID, the name associated with that ID, and the group mapping. The system returns a list with zero items if no roles match the specified criteria.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.