| Info |
|---|
| Last reviewed: 2021-07-22 |
| Tip |
|---|
| Note: The term Remove used in in the APIs is exactly the same as the Delete function. Calling any API with the Remove term will result in the associated data being deleted from the database. There is no recovery function for these Remove calls. |
| Table of Contents | ||
|---|---|---|
|
...
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
|---|---|---|---|---|---|
entities | Boolean | false | Return list of entities instead of id list. | ||
recursive | Boolean | false | Include organizations from the suborganizations. | ||
internal | Boolean | false | Include CustomerID internal organizations. | ||
roles | Boolean | false | List roles available in the organization. | ||
assignments | Boolean | false | Discover users in roles. Effective only if roles is true. | ||
assignmentEntities | Boolean | false | Return user-elements instead of userid-list. Effective only if assignments is true. | ||
applicationCount | Boolean | false | Show pending user application count for organizations (and possibly it's suborganizations). Effective only if entities is true. | ||
recursiveApplicationCount | Boolean | false | Whether to include applications in suborganizations to the count (see applicationCount above). Effective only if applicationCount is true. | ||
friendlyName | String | Include only organizations with friendly name matching the specified filter. Wildcard '*' is allowed in filter string. | |||
organizationType | String from Configured Set | Include only organizations of the specified organization TypeorganizationType. Wildcards are not allowed. | |||
maxResults | Integer | No Limit | Limit the maximum number of results. Exceeding the limit results in request error with error code 12. A value of zero means no limit. | ||
exportMode | Boolean | false | Include all information required for backups and provisioning. Effective only if entities is true. |
...