AccessProfileRead
Extracts access profile configuration data.
Usage
Use the AccessProfileRead method to extract access profile configuration data matching the input criteria. The Manage Roles and Access privilege is required.
The access profile is specified with the <Name> child element of apQuery:AccessProfile.
You can use the <NameTranslation> and <AccessProfileId> elements of apQuery:AccessProfile to retrieve access profile configuration data. The <NameTranslation> element specifies the access profile name in the user’s language, and the <AccessProfileId> element specifies an access profile ID.
The <sortspecification> child element of apQuery:ListOfAccessProfileEntry allows you to sort the access objects in the output by access object name. The format for the child element is as follows:
AccessObjectName sortorder
where sortorder can be ASC for sorting in ascending order, or DESC for sorting in decending order. If sortorder is not specified, then the sort order is ascending by default. If you do not specify AccessObjectName, or if the <sortspecification> child element has a blank value, then the access objects are listed in no specific order.
See AccessProfileUpsert for information about the access profile data specified in apData:AccessProfile.
Arguments
The following table describes the arguments taken by the AccessProfileRead method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
apQuery:AccessProfile |
The access profile query criteria. |
Yes |
Not applicable |
Input |
apData:AccessProfile |
The extracted access profile data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The access profile is returned.