RolesApi

RolesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
addMemberToRole	POST /roles/{account}/{kind}/{identifier}	Update or modify an existing role membership
removeMemberFromRole	DELETE /roles/{account}/{kind}/{identifier}	Deletes an existing role membership
showRole	GET /roles/{account}/{kind}/{identifier}	Get role information

addMemberToRole

addMemberToRole(account, kind, identifier, members, member, xRequestId)

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

Name	Type	Description	Notes
account	String	Organization account name	[default to null]
kind	String	Type of resource	[default to null]
identifier	String	ID of the role for which to get the information about	[default to null]
members	String	Returns a list of the Role's members.	[default to null]
member	String	The identifier of the Role to be added as a member.	[default to null]
xRequestId	String	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] [default to null]

Return type

null (empty response body)

Authorization

conjurAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

removeMemberFromRole

removeMemberFromRole(account, kind, identifier, members, member, xRequestId)

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

Name	Type	Description	Notes
account	String	Organization account name	[default to null]
kind	String	Type of resource	[default to null]
identifier	String	ID of the role for which to get the information about	[default to null]
members	String	Returns a list of the Role's members.	[default to null]
member	String	The identifier of the Role to be added as a member.	[default to null]
xRequestId	String	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] [default to null]

Return type

null (empty response body)

Authorization

conjurAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

showRole

Object showRole(account, kind, identifier, all, memberships, members, offset, limit, count, search, graph, xRequestId)

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

Name	Type	Description	Notes
account	String	Organization account name	[default to null]
kind	String	Type of resource	[default to null]
identifier	String	ID of the role for which to get the information about	[default to null]
all	String	Returns an array of Role IDs representing all role memberships, expanded recursively.	[optional] [default to null]
memberships	String	Returns all direct role memberships (members not expanded recursively).	[optional] [default to null]
members	String	Returns a list of the Role's members.	[optional] [default to null]
offset	Integer	When listing members, start at this item number.	[optional] [default to null]
limit	Integer	When listing members, return up to this many results.	[optional] [default to null]
count	Boolean	When listing members, if true, return only the count of members.	[optional] [default to null]
search	String	When listing members, the results will be narrowed to only those matching the provided string	[optional] [default to null]
graph	String	If included in the query returns a graph view of the role	[optional] [default to null]
xRequestId	String	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] [default to null]

Return type

Object

Authorization

conjurAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json