Interface RoleService
-
- All Implemented Interfaces:
public interface RoleService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceRoleService.WithRawResponseA view of RoleService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract RoleService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. Rolecreate(RoleCreateParams params)Create a new role. abstract Rolecreate(RoleCreateParams params, RequestOptions requestOptions)Roleretrieve(RoleRetrieveParams params)Get a role object by its id abstract Roleretrieve(RoleRetrieveParams params, RequestOptions requestOptions)Roleupdate(RoleUpdateParams params)Partially update a role object. abstract Roleupdate(RoleUpdateParams params, RequestOptions requestOptions)RoleListPagelist()List out all roles. abstract RoleListPagelist(RoleListParams params, RequestOptions requestOptions)RoleListPagelist(RoleListParams params)RoleListPagelist(RequestOptions requestOptions)Roledelete(RoleDeleteParams params)Delete a role object by its id abstract Roledelete(RoleDeleteParams params, RequestOptions requestOptions)Rolereplace(RoleReplaceParams params)Create or replace role. abstract Rolereplace(RoleReplaceParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract RoleService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
Role create(RoleCreateParams params)
Create a new role. If there is an existing role with the same name as the one specified in the request, will return the existing role unmodified
-
create
abstract Role create(RoleCreateParams params, RequestOptions requestOptions)
-
retrieve
Role retrieve(RoleRetrieveParams params)
Get a role object by its id
-
retrieve
abstract Role retrieve(RoleRetrieveParams params, RequestOptions requestOptions)
-
update
Role update(RoleUpdateParams params)
Partially update a role object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
-
update
abstract Role update(RoleUpdateParams params, RequestOptions requestOptions)
-
list
RoleListPage list()
List out all roles. The roles are sorted by creation date, with the most recently-created roles coming first
-
list
abstract RoleListPage list(RoleListParams params, RequestOptions requestOptions)
-
list
RoleListPage list(RoleListParams params)
-
list
RoleListPage list(RequestOptions requestOptions)
-
delete
Role delete(RoleDeleteParams params)
Delete a role object by its id
-
delete
abstract Role delete(RoleDeleteParams params, RequestOptions requestOptions)
-
replace
Role replace(RoleReplaceParams params)
Create or replace role. If there is an existing role with the same name as the one specified in the request, will replace the existing role with the provided fields
-
replace
abstract Role replace(RoleReplaceParams params, RequestOptions requestOptions)
-
-
-
-