com.cyberark.conjur.sdk.endpoint

Class RolesApi

java.lang.Object

com.cyberark.conjur.sdk.endpoint.RolesApi

public class RolesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RolesApi()
RolesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	addMemberToRole(String account, String kind, String identifier, String members, String member) Update or modify an existing role membership Updates or modifies an existing role membership.
void	addMemberToRole(String account, String kind, String identifier, String members, String member, String xRequestId) Update or modify an existing role membership Updates or modifies an existing role membership.
okhttp3.Call	addMemberToRoleAsync(String account, String kind, String identifier, String members, String member, String xRequestId, ApiCallback<Void> _callback) Update or modify an existing role membership (asynchronously) Updates or modifies an existing role membership.
okhttp3.Call	addMemberToRoleCall(String account, String kind, String identifier, String members, String member, String xRequestId, ApiCallback _callback) Build call for addMemberToRole
ApiResponse<Void>	addMemberToRoleWithHttpInfo(String account, String kind, String identifier, String members, String member) Update or modify an existing role membership Updates or modifies an existing role membership.
ApiResponse<Void>	addMemberToRoleWithHttpInfo(String account, String kind, String identifier, String members, String member, String xRequestId) Update or modify an existing role membership Updates or modifies an existing role membership.
ApiClient	getApiClient()
void	removeMemberFromRole(String account, String kind, String identifier, String members, String member) Deletes an existing role membership Deletes an existing role membership.
void	removeMemberFromRole(String account, String kind, String identifier, String members, String member, String xRequestId) Deletes an existing role membership Deletes an existing role membership.
okhttp3.Call	removeMemberFromRoleAsync(String account, String kind, String identifier, String members, String member, String xRequestId, ApiCallback<Void> _callback) Deletes an existing role membership (asynchronously) Deletes an existing role membership.
okhttp3.Call	removeMemberFromRoleCall(String account, String kind, String identifier, String members, String member, String xRequestId, ApiCallback _callback) Build call for removeMemberFromRole
ApiResponse<Void>	removeMemberFromRoleWithHttpInfo(String account, String kind, String identifier, String members, String member) Deletes an existing role membership Deletes an existing role membership.
ApiResponse<Void>	removeMemberFromRoleWithHttpInfo(String account, String kind, String identifier, String members, String member, String xRequestId) Deletes an existing role membership Deletes an existing role membership.
void	setApiClient(ApiClient apiClient)
Object	showRole(String account, String kind, String identifier) Get role information Gets detailed information about a specific role, including the role members.
Object	showRole(String account, String kind, String identifier, String all, String memberships, String members, Integer offset, Integer limit, Boolean count, String search, String graph, String xRequestId) Get role information Gets detailed information about a specific role, including the role members.
okhttp3.Call	showRoleAsync(String account, String kind, String identifier, String all, String memberships, String members, Integer offset, Integer limit, Boolean count, String search, String graph, String xRequestId, ApiCallback<Object> _callback) Get role information (asynchronously) Gets detailed information about a specific role, including the role members.
okhttp3.Call	showRoleCall(String account, String kind, String identifier, String all, String memberships, String members, Integer offset, Integer limit, Boolean count, String search, String graph, String xRequestId, ApiCallback _callback) Build call for showRole
ApiResponse<Object>	showRoleWithHttpInfo(String account, String kind, String identifier) Get role information Gets detailed information about a specific role, including the role members.
ApiResponse<Object>	showRoleWithHttpInfo(String account, String kind, String identifier, String all, String memberships, String members, Integer offset, Integer limit, Boolean count, String search, String graph, String xRequestId) Get role information Gets detailed information about a specific role, including the role members.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RolesApi

public RolesApi()

RolesApi

public RolesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addMemberToRoleCall

public okhttp3.Call addMemberToRoleCall(String account,
                                        String kind,
                                        String identifier,
                                        String members,
                                        String member,
                                        String xRequestId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for addMemberToRole

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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
204	Member was added to role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

addMemberToRole

public void addMemberToRole(String account,
                            String kind,
                            String identifier,
                            String members,
                            String member,
                            String xRequestId)
                     throws ApiException

Update or modify an existing role membership Updates or modifies an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be added as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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)

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
204	Member was added to role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

addMemberToRole

public void addMemberToRole(String account,
                            String kind,
                            String identifier,
                            String members,
                            String member)
                     throws ApiException

Update or modify an existing role membership Updates or modifies an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be added as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the role for which to get the information about

members - Returns a list of the Role's members.

member - The identifier of the Role to be added as a member.

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
204	Member was added to role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

addMemberToRoleWithHttpInfo

public ApiResponse<Void> addMemberToRoleWithHttpInfo(String account,
                                                     String kind,
                                                     String identifier,
                                                     String members,
                                                     String member,
                                                     String xRequestId)
                                              throws ApiException

Update or modify an existing role membership Updates or modifies an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be added as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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<Void>

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
204	Member was added to role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

addMemberToRoleWithHttpInfo

public ApiResponse<Void> addMemberToRoleWithHttpInfo(String account,
                                                     String kind,
                                                     String identifier,
                                                     String members,
                                                     String member)
                                              throws ApiException

Update or modify an existing role membership Updates or modifies an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be added as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the role for which to get the information about

members - Returns a list of the Role's members.

member - The identifier of the Role to be added as a member.

Returns:

ApiResponse<Void>

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
204	Member was added to role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

addMemberToRoleAsync

public okhttp3.Call addMemberToRoleAsync(String account,
                                         String kind,
                                         String identifier,
                                         String members,
                                         String member,
                                         String xRequestId,
                                         ApiCallback<Void> _callback)
                                  throws ApiException

Update or modify an existing role membership (asynchronously) Updates or modifies an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be added as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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
204	Member was added to role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

removeMemberFromRoleCall

public okhttp3.Call removeMemberFromRoleCall(String account,
                                             String kind,
                                             String identifier,
                                             String members,
                                             String member,
                                             String xRequestId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for removeMemberFromRole

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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
204	Member was deleted from role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

removeMemberFromRole

public void removeMemberFromRole(String account,
                                 String kind,
                                 String identifier,
                                 String members,
                                 String member,
                                 String xRequestId)
                          throws ApiException

Deletes an existing role membership Deletes an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be removed as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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)

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
204	Member was deleted from role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

removeMemberFromRole

public void removeMemberFromRole(String account,
                                 String kind,
                                 String identifier,
                                 String members,
                                 String member)
                          throws ApiException

Deletes an existing role membership Deletes an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be removed as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the role for which to get the information about

members - Returns a list of the Role's members.

member - The identifier of the Role to be added as a member.

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
204	Member was deleted from role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

removeMemberFromRoleWithHttpInfo

public ApiResponse<Void> removeMemberFromRoleWithHttpInfo(String account,
                                                          String kind,
                                                          String identifier,
                                                          String members,
                                                          String member,
                                                          String xRequestId)
                                                   throws ApiException

Deletes an existing role membership Deletes an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be removed as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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<Void>

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
204	Member was deleted from role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

removeMemberFromRoleWithHttpInfo

public ApiResponse<Void> removeMemberFromRoleWithHttpInfo(String account,
                                                          String kind,
                                                          String identifier,
                                                          String members,
                                                          String member)
                                                   throws ApiException

Deletes an existing role membership Deletes an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be removed as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the role for which to get the information about

members - Returns a list of the Role's members.

member - The identifier of the Role to be added as a member.

Returns:

ApiResponse<Void>

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
204	Member was deleted from role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

removeMemberFromRoleAsync

public okhttp3.Call removeMemberFromRoleAsync(String account,
                                              String kind,
                                              String identifier,
                                              String members,
                                              String member,
                                              String xRequestId,
                                              ApiCallback<Void> _callback)
                                       throws ApiException

Deletes an existing role membership (asynchronously) Deletes an existing role membership. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. When the `members` query parameter is provided, you will get the members of a role. When the `members` and `member` query parameters are provided, the role specfified by `member` will be removed as a member of the role specified in the endpoint URI.

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

members - Returns a list of the Role's members. (required)

member - The identifier of the Role to be added as a member. (required)

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
204	Member was deleted from role successfully	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

showRoleCall

public okhttp3.Call showRoleCall(String account,
                                 String kind,
                                 String identifier,
                                 String all,
                                 String memberships,
                                 String members,
                                 Integer offset,
                                 Integer limit,
                                 Boolean count,
                                 String search,
                                 String graph,
                                 String xRequestId,
                                 ApiCallback _callback)
                          throws ApiException

Build call for showRole

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

all - Returns an array of Role IDs representing all role memberships, expanded recursively. (optional)

memberships - Returns all direct role memberships (members not expanded recursively). (optional)

members - Returns a list of the Role's members. (optional)

offset - When listing members, start at this item number. (optional)

limit - When listing members, return up to this many results. (optional)

count - When listing members, if `true`, return only the count of members. (optional)

search - When listing members, the results will be narrowed to only those matching the provided string (optional)

graph - If included in the query returns a graph view of the role (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 requested role(s)/member(s)	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

showRole

public Object showRole(String account,
                       String kind,
                       String identifier,
                       String all,
                       String memberships,
                       String members,
                       Integer offset,
                       Integer limit,
                       Boolean count,
                       String search,
                       String graph,
                       String xRequestId)
                throws ApiException

Get role information Gets detailed information about a specific role, including the role members. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. ##### Listing members If `members` is provided, you will get the members of a role. 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 weights 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. ##### Parameter Priority If Conjur is given any combination of optional parameters, it responds with ONLY results for the parameter of the highest priority. 1. `graph` 2. `all` 3. `memberships` 4. `members`

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

all - Returns an array of Role IDs representing all role memberships, expanded recursively. (optional)

memberships - Returns all direct role memberships (members not expanded recursively). (optional)

members - Returns a list of the Role's members. (optional)

offset - When listing members, start at this item number. (optional)

limit - When listing members, return up to this many results. (optional)

count - When listing members, if `true`, return only the count of members. (optional)

search - When listing members, the results will be narrowed to only those matching the provided string (optional)

graph - If included in the query returns a graph view of the role (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:

Object

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 requested role(s)/member(s)	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

showRole

public Object showRole(String account,
                       String kind,
                       String identifier)
                throws ApiException

Get role information Gets detailed information about a specific role, including the role members. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. ##### Listing members If `members` is provided, you will get the members of a role. 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 weights 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. ##### Parameter Priority If Conjur is given any combination of optional parameters, it responds with ONLY results for the parameter of the highest priority. 1. `graph` 2. `all` 3. `memberships` 4. `members`

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the role for which to get the information about

Returns:

Object

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 requested role(s)/member(s)	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

showRoleWithHttpInfo

public ApiResponse<Object> showRoleWithHttpInfo(String account,
                                                String kind,
                                                String identifier,
                                                String all,
                                                String memberships,
                                                String members,
                                                Integer offset,
                                                Integer limit,
                                                Boolean count,
                                                String search,
                                                String graph,
                                                String xRequestId)
                                         throws ApiException

Get role information Gets detailed information about a specific role, including the role members. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. ##### Listing members If `members` is provided, you will get the members of a role. 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 weights 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. ##### Parameter Priority If Conjur is given any combination of optional parameters, it responds with ONLY results for the parameter of the highest priority. 1. `graph` 2. `all` 3. `memberships` 4. `members`

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

all - Returns an array of Role IDs representing all role memberships, expanded recursively. (optional)

memberships - Returns all direct role memberships (members not expanded recursively). (optional)

members - Returns a list of the Role's members. (optional)

offset - When listing members, start at this item number. (optional)

limit - When listing members, return up to this many results. (optional)

count - When listing members, if `true`, return only the count of members. (optional)

search - When listing members, the results will be narrowed to only those matching the provided string (optional)

graph - If included in the query returns a graph view of the role (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<Object>

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 requested role(s)/member(s)	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

showRoleWithHttpInfo

public ApiResponse<Object> showRoleWithHttpInfo(String account,
                                                String kind,
                                                String identifier)
                                         throws ApiException

Get role information Gets detailed information about a specific role, including the role members. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. ##### Listing members If `members` is provided, you will get the members of a role. 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 weights 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. ##### Parameter Priority If Conjur is given any combination of optional parameters, it responds with ONLY results for the parameter of the highest priority. 1. `graph` 2. `all` 3. `memberships` 4. `members`

Parameters:

account - Organization account name

kind - Type of resource

identifier - ID of the role for which to get the information about

Returns:

ApiResponse<Object>

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 requested role(s)/member(s)	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-

showRoleAsync

public okhttp3.Call showRoleAsync(String account,
                                  String kind,
                                  String identifier,
                                  String all,
                                  String memberships,
                                  String members,
                                  Integer offset,
                                  Integer limit,
                                  Boolean count,
                                  String search,
                                  String graph,
                                  String xRequestId,
                                  ApiCallback<Object> _callback)
                           throws ApiException

Get role information (asynchronously) Gets detailed information about a specific role, including the role members. If a role A is granted to a role B, then role A is said to have role B as a member. These relationships are described in the “members” portion of the returned JSON. ##### Listing members If `members` is provided, you will get the members of a role. 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 weights 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. ##### Parameter Priority If Conjur is given any combination of optional parameters, it responds with ONLY results for the parameter of the highest priority. 1. `graph` 2. `all` 3. `memberships` 4. `members`

Parameters:

account - Organization account name (required)

kind - Type of resource (required)

identifier - ID of the role for which to get the information about (required)

all - Returns an array of Role IDs representing all role memberships, expanded recursively. (optional)

memberships - Returns all direct role memberships (members not expanded recursively). (optional)

members - Returns a list of the Role's members. (optional)

offset - When listing members, start at this item number. (optional)

limit - When listing members, return up to this many results. (optional)

count - When listing members, if `true`, return only the count of members. (optional)

search - When listing members, the results will be narrowed to only those matching the provided string (optional)

graph - If included in the query returns a graph view of the role (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 requested role(s)/member(s)	-
400	The server cannot process the request due to malformed request syntax	-
401	Authentication information is missing or invalid	-
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.	-