Package com.cyberark.conjur.sdk.endpoint
Class ResourcesApi
java.lang.Object
com.cyberark.conjur.sdk.endpoint.ResourcesApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidsetApiClient(ApiClient apiClient) showResource(String account, String kind, String identifier) Shows a description of a single resource.showResource(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId) Shows a description of a single resource.okhttp3.CallshowResourceAsync(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId, ApiCallback<Resource> _callback) Shows a description of a single resource.okhttp3.CallshowResourceCall(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId, ApiCallback _callback) Build call for showResourceshowResourcesForAccount(String account) Lists resources within an organization account.showResourcesForAccount(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) Lists resources within an organization account.okhttp3.CallshowResourcesForAccountAsync(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback<List<Resource>> _callback) Lists resources within an organization account.okhttp3.CallshowResourcesForAccountCall(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback _callback) Build call for showResourcesForAccountLists resources within an organization account.showResourcesForAccountWithHttpInfo(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) Lists resources within an organization account.Lists resources within an organization account.showResourcesForAllAccounts(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) Lists resources within an organization account.okhttp3.CallshowResourcesForAllAccountsAsync(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback<List<Resource>> _callback) Lists resources within an organization account.okhttp3.CallshowResourcesForAllAccountsCall(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback _callback) Build call for showResourcesForAllAccountsLists resources within an organization account.showResourcesForAllAccountsWithHttpInfo(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) Lists resources within an organization account.showResourcesForKind(String account, String kind) Lists resources of the same kind within an organization account.showResourcesForKind(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) Lists resources of the same kind within an organization account.okhttp3.CallshowResourcesForKindAsync(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback<List<Resource>> _callback) Lists resources of the same kind within an organization account.okhttp3.CallshowResourcesForKindCall(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback _callback) Build call for showResourcesForKindshowResourcesForKindWithHttpInfo(String account, String kind) Lists resources of the same kind within an organization account.showResourcesForKindWithHttpInfo(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) Lists resources of the same kind within an organization account.showResourceWithHttpInfo(String account, String kind, String identifier) Shows a description of a single resource.showResourceWithHttpInfo(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId) Shows a description of a single resource.
-
Constructor Details
-
ResourcesApi
public ResourcesApi() -
ResourcesApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
showResourceCall
public okhttp3.Call showResourceCall(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId, ApiCallback _callback) throws ApiException Build call for showResource- Parameters:
account- Organization account name (required)kind- Type of resource (required)identifier- ID of the resource for which to get the information about (required)permittedRoles- Lists the roles which have the named privilege on a resource. (optional)privilege- Level of privilege to filter on. Can only be used in combination with `permitted_roles` or `check` parameter. (optional)check- Check whether a role has a privilege on a resource. (optional)role- Role to check privilege on. Can only be used in combination with `check` parameter. (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains the list of role memberships or permitted roles - 204 Permissions check was successful - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 404 The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set - 422 A request parameter was either missing or invalid. -
-
showResource
public Resource showResource(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId) throws ApiException Shows a description of a single resource. Details about a single resource. If `permitted_roles` and `privilege` are given, Conjur lists the roles with the specified privilege on the resource. If `check`, `privilege` and `role` are given, Conjur checks if the specified role has the privilege on the resource. If `permitted_roles` and `check` are both given, Conjur responds to the `check` call ONLY. ##### Permissions Required- Parameters:
account- Organization account name (required)kind- Type of resource (required)identifier- ID of the resource for which to get the information about (required)permittedRoles- Lists the roles which have the named privilege on a resource. (optional)privilege- Level of privilege to filter on. Can only be used in combination with `permitted_roles` or `check` parameter. (optional)check- Check whether a role has a privilege on a resource. (optional)role- Role to check privilege on. Can only be used in combination with `check` parameter. (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- Resource
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains the list of role memberships or permitted roles - 204 Permissions check was successful - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 404 The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set - 422 A request parameter was either missing or invalid. -
-
showResource
Shows a description of a single resource. Details about a single resource. If `permitted_roles` and `privilege` are given, Conjur lists the roles with the specified privilege on the resource. If `check`, `privilege` and `role` are given, Conjur checks if the specified role has the privilege on the resource. If `permitted_roles` and `check` are both given, Conjur responds to the `check` call ONLY. ##### Permissions Required- Parameters:
account- Organization account namekind- Type of resourceidentifier- ID of the resource for which to get the information about- Returns:
- Resource
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains the list of role memberships or permitted roles - 204 Permissions check was successful - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 404 The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set - 422 A request parameter was either missing or invalid. -
-
showResourceWithHttpInfo
public ApiResponse<Resource> showResourceWithHttpInfo(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId) throws ApiException Shows a description of a single resource. Details about a single resource. If `permitted_roles` and `privilege` are given, Conjur lists the roles with the specified privilege on the resource. If `check`, `privilege` and `role` are given, Conjur checks if the specified role has the privilege on the resource. If `permitted_roles` and `check` are both given, Conjur responds to the `check` call ONLY. ##### Permissions Required- Parameters:
account- Organization account name (required)kind- Type of resource (required)identifier- ID of the resource for which to get the information about (required)permittedRoles- Lists the roles which have the named privilege on a resource. (optional)privilege- Level of privilege to filter on. Can only be used in combination with `permitted_roles` or `check` parameter. (optional)check- Check whether a role has a privilege on a resource. (optional)role- Role to check privilege on. Can only be used in combination with `check` parameter. (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- ApiResponse<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains the list of role memberships or permitted roles - 204 Permissions check was successful - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 404 The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set - 422 A request parameter was either missing or invalid. -
-
showResourceWithHttpInfo
public ApiResponse<Resource> showResourceWithHttpInfo(String account, String kind, String identifier) throws ApiException Shows a description of a single resource. Details about a single resource. If `permitted_roles` and `privilege` are given, Conjur lists the roles with the specified privilege on the resource. If `check`, `privilege` and `role` are given, Conjur checks if the specified role has the privilege on the resource. If `permitted_roles` and `check` are both given, Conjur responds to the `check` call ONLY. ##### Permissions Required- Parameters:
account- Organization account namekind- Type of resourceidentifier- ID of the resource for which to get the information about- Returns:
- ApiResponse<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains the list of role memberships or permitted roles - 204 Permissions check was successful - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 404 The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set - 422 A request parameter was either missing or invalid. -
-
showResourceAsync
public okhttp3.Call showResourceAsync(String account, String kind, String identifier, Boolean permittedRoles, String privilege, Boolean check, String role, String xRequestId, ApiCallback<Resource> _callback) throws ApiException Shows a description of a single resource. (asynchronously) Details about a single resource. If `permitted_roles` and `privilege` are given, Conjur lists the roles with the specified privilege on the resource. If `check`, `privilege` and `role` are given, Conjur checks if the specified role has the privilege on the resource. If `permitted_roles` and `check` are both given, Conjur responds to the `check` call ONLY. ##### Permissions Required- Parameters:
account- Organization account name (required)kind- Type of resource (required)identifier- ID of the resource for which to get the information about (required)permittedRoles- Lists the roles which have the named privilege on a resource. (optional)privilege- Level of privilege to filter on. Can only be used in combination with `permitted_roles` or `check` parameter. (optional)check- Check whether a role has a privilege on a resource. (optional)role- Role to check privilege on. Can only be used in combination with `check` parameter. (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains the list of role memberships or permitted roles - 204 Permissions check was successful - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 404 The requested resource does not exist, the authenticated user lacks the required privileges to enumerate this resource, or its value has not been set - 422 A request parameter was either missing or invalid. -
-
showResourcesForAccountCall
public okhttp3.Call showResourcesForAccountCall(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback _callback) throws ApiException Build call for showResourcesForAccount- Parameters:
account- Organization account name (required)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAccount
public List<Resource> showResourcesForAccount(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) throws ApiException Lists resources within an organization account. Lists resources within an organization account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name (required)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- List<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAccount
Lists resources within an organization account. Lists resources within an organization account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name- Returns:
- List<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAccountWithHttpInfo
public ApiResponse<List<Resource>> showResourcesForAccountWithHttpInfo(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) throws ApiException Lists resources within an organization account. Lists resources within an organization account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name (required)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- ApiResponse<List<Resource>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAccountWithHttpInfo
public ApiResponse<List<Resource>> showResourcesForAccountWithHttpInfo(String account) throws ApiException Lists resources within an organization account. Lists resources within an organization account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name- Returns:
- ApiResponse<List<Resource>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAccountAsync
public okhttp3.Call showResourcesForAccountAsync(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback<List<Resource>> _callback) throws ApiException Lists resources within an organization account. (asynchronously) Lists resources within an organization account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name (required)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAllAccountsCall
public okhttp3.Call showResourcesForAllAccountsCall(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback _callback) throws ApiException Build call for showResourcesForAllAccounts- Parameters:
account- Organization account name (optional)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAllAccounts
public List<Resource> showResourcesForAllAccounts(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) throws ApiException Lists resources within an organization account. Lists resources within an organization account. In the absence of an `account` query parameter, shows results for the account of the authorization token user. If an `account` query parameter is given, shows results for the specified account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.\"- Parameters:
account- Organization account name (optional)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- List<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAllAccounts
Lists resources within an organization account. Lists resources within an organization account. In the absence of an `account` query parameter, shows results for the account of the authorization token user. If an `account` query parameter is given, shows results for the specified account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.\"- Returns:
- List<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAllAccountsWithHttpInfo
public ApiResponse<List<Resource>> showResourcesForAllAccountsWithHttpInfo(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) throws ApiException Lists resources within an organization account. Lists resources within an organization account. In the absence of an `account` query parameter, shows results for the account of the authorization token user. If an `account` query parameter is given, shows results for the specified account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.\"- Parameters:
account- Organization account name (optional)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- ApiResponse<List<Resource>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAllAccountsWithHttpInfo
Lists resources within an organization account. Lists resources within an organization account. In the absence of an `account` query parameter, shows results for the account of the authorization token user. If an `account` query parameter is given, shows results for the specified account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.\"- Returns:
- ApiResponse<List<Resource>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForAllAccountsAsync
public okhttp3.Call showResourcesForAllAccountsAsync(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback<List<Resource>> _callback) throws ApiException Lists resources within an organization account. (asynchronously) Lists resources within an organization account. In the absence of an `account` query parameter, shows results for the account of the authorization token user. If an `account` query parameter is given, shows results for the specified account. If a `kind` query parameter is given, narrows results to only resources of that kind. If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.\"- Parameters:
account- Organization account name (optional)kind- Type of resource (optional)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForKindCall
public okhttp3.Call showResourcesForKindCall(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback _callback) throws ApiException Build call for showResourcesForKind- Parameters:
account- Organization account name (required)kind- Type of resource (required)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForKind
public List<Resource> showResourcesForKind(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) throws ApiException Lists resources of the same kind within an organization account. Lists resources of the same kind within an organization account. Kinds of resources include: policy, user, host, group, layer, or variable If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name (required)kind- Type of resource (required)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- List<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForKind
Lists resources of the same kind within an organization account. Lists resources of the same kind within an organization account. Kinds of resources include: policy, user, host, group, layer, or variable If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account namekind- Type of resource- Returns:
- List<Resource>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForKindWithHttpInfo
public ApiResponse<List<Resource>> showResourcesForKindWithHttpInfo(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId) throws ApiException Lists resources of the same kind within an organization account. Lists resources of the same kind within an organization account. Kinds of resources include: policy, user, host, group, layer, or variable If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name (required)kind- Type of resource (required)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)- Returns:
- ApiResponse<List<Resource>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForKindWithHttpInfo
public ApiResponse<List<Resource>> showResourcesForKindWithHttpInfo(String account, String kind) throws ApiException Lists resources of the same kind within an organization account. Lists resources of the same kind within an organization account. Kinds of resources include: policy, user, host, group, layer, or variable If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account namekind- Type of resource- Returns:
- ApiResponse<List<Resource>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-
showResourcesForKindAsync
public okhttp3.Call showResourcesForKindAsync(String account, String kind, String search, Integer offset, Integer limit, Boolean count, String role, String actingAs, String xRequestId, ApiCallback<List<Resource>> _callback) throws ApiException Lists resources of the same kind within an organization account. (asynchronously) Lists resources of the same kind within an organization account. Kinds of resources include: policy, user, host, group, layer, or variable If a `limit` is given, returns no more than that number of results. Providing an `offset` skips a number of resources before returning the rest. In addition, providing an `offset` will give `limit` a default value of 10 if none other is provided. These two parameters can be combined to page through results. If the parameter `count` is `true`, returns only the number of items in the list. ##### Text search If the `search` parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called `name` appear first, then those with another matching annotation value, and finally those with a matching `kind`.- Parameters:
account- Organization account name (required)kind- Type of resource (required)search- Filter resources based on this value by name (optional)offset- When listing resources, start at this item number. (optional)limit- When listing resources, return up to this many results. (optional)count- When listing resources, if `true`, return only the count of the results. (optional)role- Retrieves the resources list for a different role if the authenticated role has access (optional)actingAs- Retrieves the resources list for a different role if the authenticated role has access (optional)xRequestId- Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details:
Status Code Description Response Headers 200 The response body contains a list of resources - 400 The server cannot process the request due to malformed request syntax - 401 Authentication information is missing or invalid - 403 The authenticated user lacks the necessary privileges - 422 A request parameter was either missing or invalid. -
-