Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, request *management.CreateRoleRequestContent, ...) (*management.CreateRoleResponseContent, error)
- func (c *Client) Delete(ctx context.Context, id string, opts ...option.RequestOption) error
- func (c *Client) Get(ctx context.Context, id string, opts ...option.RequestOption) (*management.GetRoleResponseContent, error)
- func (c *Client) List(ctx context.Context, request *management.ListRolesRequestParameters, ...) (...)
- func (c *Client) Update(ctx context.Context, id string, request *management.UpdateRoleRequestContent, ...) (*management.UpdateRoleResponseContent, error)
- type RawClient
- func (r *RawClient) Create(ctx context.Context, request *management.CreateRoleRequestContent, ...) (*core.Response[*management.CreateRoleResponseContent], error)
- func (r *RawClient) Delete(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[any], error)
- func (r *RawClient) Get(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[*management.GetRoleResponseContent], error)
- func (r *RawClient) Update(ctx context.Context, id string, request *management.UpdateRoleRequestContent, ...) (*core.Response[*management.UpdateRoleResponseContent], error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
WithRawResponse *RawClient
Groups *groups.Client
Permissions *permissions.Client
Users *users.Client
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(options *core.RequestOptions) *Client
func (*Client) Create ¶
func (c *Client) Create( ctx context.Context, request *management.CreateRoleRequestContent, opts ...option.RequestOption, ) (*management.CreateRoleResponseContent, error)
Create a user role for [Role-Based Access Control](https://auth0.com/docs/manage-users/access-control/rbac).
**Note**: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.
func (*Client) Delete ¶
Delete a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.
func (*Client) Get ¶
func (c *Client) Get( ctx context.Context, id string, opts ...option.RequestOption, ) (*management.GetRoleResponseContent, error)
Retrieve details about a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) specified by ID.
func (*Client) List ¶
func (c *Client) List( ctx context.Context, request *management.ListRolesRequestParameters, opts ...option.RequestOption, ) (*core.Page[*int, *management.Role, *management.ListRolesOffsetPaginatedResponseContent], error)
Retrieve detailed list of user roles created in your tenant.
**Note**: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.
func (*Client) Update ¶
func (c *Client) Update( ctx context.Context, id string, request *management.UpdateRoleRequestContent, opts ...option.RequestOption, ) (*management.UpdateRoleResponseContent, error)
Modify the details of a specific [user role](https://auth0.com/docs/manage-users/access-control/rbac) specified by ID.
type RawClient ¶
type RawClient struct {
// contains filtered or unexported fields
}
func NewRawClient ¶
func NewRawClient(options *core.RequestOptions) *RawClient
func (*RawClient) Create ¶
func (r *RawClient) Create( ctx context.Context, request *management.CreateRoleRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.CreateRoleResponseContent], error)
func (*RawClient) Get ¶
func (r *RawClient) Get( ctx context.Context, id string, opts ...option.RequestOption, ) (*core.Response[*management.GetRoleResponseContent], error)
func (*RawClient) Update ¶
func (r *RawClient) Update( ctx context.Context, id string, request *management.UpdateRoleRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.UpdateRoleResponseContent], error)