roles

Documentation

Overview

Package roles contains methods related to Roles

Index

• type RolesV1
  • func (r *RolesV1) ListRoles() (*models.ListRolesResponse, *apiutils.APIError)
  • func (r *RolesV1) ReadRole(roleId string) (*models.ReadRoleResponse, *apiutils.APIError)
• type RolesV1Client
  • func NewRolesV1(config config.Config) RolesV1Client

Types

type RolesV1

type RolesV1 struct {
	// contains filtered or unexported fields
}

RolesV1 represents a custom type struct

func (*RolesV1) ListRoles

func (r *RolesV1) ListRoles() (
	*models.ListRolesResponse, *apiutils.APIError)

ListRoles Returns a list of roles that can be assigned to users, either while inviting users using the

[POST /users](#operation/create-user) API, or by updating the user using the
[PATCH /users/{user_id}](#operation/update-user) API.

func (*RolesV1) ReadRole

func (r *RolesV1) ReadRole(
	roleId string) (
	*models.ReadRoleResponse, *apiutils.APIError)

ReadRole Returns a representation of the specified role.

type RolesV1Client

type RolesV1Client interface {
	// ListRoles Returns a list of roles that can be assigned to users, either while inviting users using the
	//  [POST /users](#operation/create-user) API, or by updating the user using the
	//  [PATCH /users/{user_id}](#operation/update-user) API.
	ListRoles() (
		*models.ListRolesResponse, *apiutils.APIError)

	// ReadRole Returns a representation of the specified role.
	ReadRole(
		roleId string) (
		*models.ReadRoleResponse, *apiutils.APIError)
}

RolesV1Client represents a custom type interface

func NewRolesV1

func NewRolesV1(config config.Config) RolesV1Client

NewRolesV1 returns RolesV1Client