| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /securitymappings | Retrieve a security mapping by path. |
| get | GET /securitymappings/{webId} | Retrieve a security mapping. |
| update | PATCH /securitymappings/{webId} | Update a security mapping by replacing items in its definition. |
| delete | DELETE /securitymappings/{webId} | Delete a security mapping. |
| getSecurity | GET /securitymappings/{webId}/security | Get the security information of the specified security item associated with the security mapping for a specified user. |
| getSecurityEntries | GET /securitymappings/{webId}/securityentries | Retrieve the security entries associated with the security mapping based on the specified criteria. By default, all security entries for this security mapping are returned. |
| getSecurityEntryByName | GET /securitymappings/{webId}/securityentries/{name} | Retrieve the security entry associated with the security mapping with the specified name. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve a security mapping by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the security mapping.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Retrieve a security mapping.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the security mapping.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update(String webId, PISecurityMapping securityMapping)
Update a security mapping by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the security mapping.. | [required] |
| securityMapping | PISecurityMapping | A partial security mapping containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete a security mapping.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the security mapping.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurity(String webId, List userIdentity, Boolean forceRefresh, String selectedFields, String webIdType)
Get the security information of the specified security item associated with the security mapping for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the security mapping for the security to be checked.. | [required] |
| userIdentity | List | The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned.. | [required] |
| forceRefresh | Boolean | Indicates if the security cache should be refreshed before getting security information. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntries(String webId, String nameFilter, String selectedFields, String webIdType)
Retrieve the security entries associated with the security mapping based on the specified criteria. By default, all security entries for this security mapping are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the security mapping.. | [required] |
| nameFilter | String | The name query string used for filtering security entries. The default is no filter.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntryByName(String name, String webId, String selectedFields, String webIdType)
Retrieve the security entry associated with the security mapping with the specified name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username.. | [required] |
| webId | String | The ID of the security mapping.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]