organizationalunits

Documentation

Overview

Package organizationalunits contains methods related to OrganizationalUnits

Index

• type OrganizationalUnitsV1
  • func (o *OrganizationalUnitsV1) CreateOrganizationalUnit(embed *string, body *models.CreateOrganizationalUnitV1Request) (*models.CreateOrganizationalUnitV1ResponseWrapper, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) DeleteOrganizationalUnit(id string, embed *string) (*models.DeleteOrganizationalUnitResponse, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) ListOrganizationalUnits(limit *int64, start *string, filter *string) (*models.ListOrganizationalUnitsResponseV1, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) PatchOrganizationalUnit(id string, embed *string, body *models.PatchOrganizationalUnitV1Request) (*models.PatchOrganizationalUnitV1ResponseWrapper, *apiutils.APIError)
  • func (o *OrganizationalUnitsV1) ReadOrganizationalUnit(id string, embed *string) (*models.ReadOrganizationalUnitResponseV1, *apiutils.APIError)
• type OrganizationalUnitsV1Client
  • func NewOrganizationalUnitsV1(config config.Config) OrganizationalUnitsV1Client

Types

type OrganizationalUnitsV1

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

OrganizationalUnitsV1 represents a custom type struct

func (*OrganizationalUnitsV1) CreateOrganizationalUnit

func (o *OrganizationalUnitsV1) CreateOrganizationalUnit(
	embed *string,
	body *models.CreateOrganizationalUnitV1Request) (
	*models.CreateOrganizationalUnitV1ResponseWrapper, *apiutils.APIError)

CreateOrganizationalUnit Create a new organizational unit. Adding entities to the OU is an asynchronous operation and has a task associated.

When the request has entities to be added, the response has a task ID which can be used to
track the progress of the operation.

func (*OrganizationalUnitsV1) DeleteOrganizationalUnit

func (o *OrganizationalUnitsV1) DeleteOrganizationalUnit(
	id string,
	embed *string) (
	*models.DeleteOrganizationalUnitResponse, *apiutils.APIError)

DeleteOrganizationalUnit Delete the specified organizational unit.

func (*OrganizationalUnitsV1) ListOrganizationalUnits

func (o *OrganizationalUnitsV1) ListOrganizationalUnits(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListOrganizationalUnitsResponseV1, *apiutils.APIError)

ListOrganizationalUnits Returns a list of organizational units.

func (*OrganizationalUnitsV1) PatchOrganizationalUnit

func (o *OrganizationalUnitsV1) PatchOrganizationalUnit(
	id string,
	embed *string,
	body *models.PatchOrganizationalUnitV1Request) (
	*models.PatchOrganizationalUnitV1ResponseWrapper, *apiutils.APIError)

PatchOrganizationalUnit Patch the specified organizational unit.

The complete updated attribute(s) of the organizational unit have to be provided in the request.
Adding or removing entities from the OU is an asynchronous operation and has a task associated.
When the request has entities to be added or removed, the response has a task ID
which can be used to track the progress of the operation.

func (*OrganizationalUnitsV1) ReadOrganizationalUnit

func (o *OrganizationalUnitsV1) ReadOrganizationalUnit(
	id string,
	embed *string) (
	*models.ReadOrganizationalUnitResponseV1, *apiutils.APIError)

ReadOrganizationalUnit Returns a representation of the specified organizational unit.

type OrganizationalUnitsV1Client

type OrganizationalUnitsV1Client interface {
	// ListOrganizationalUnits Returns a list of organizational units.
	ListOrganizationalUnits(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListOrganizationalUnitsResponseV1, *apiutils.APIError)

	// CreateOrganizationalUnit Create a new organizational unit. Adding entities to the OU is an asynchronous operation and has a task associated.
	//  When the request has entities to be added, the response has a task ID which can be used to
	//  track the progress of the operation.
	CreateOrganizationalUnit(
		embed *string,
		body *models.CreateOrganizationalUnitV1Request) (
		*models.CreateOrganizationalUnitV1ResponseWrapper, *apiutils.APIError)

	// ReadOrganizationalUnit Returns a representation of the specified organizational unit.
	ReadOrganizationalUnit(
		id string,
		embed *string) (
		*models.ReadOrganizationalUnitResponseV1, *apiutils.APIError)

	// DeleteOrganizationalUnit Delete the specified organizational unit.
	DeleteOrganizationalUnit(
		id string,
		embed *string) (
		*models.DeleteOrganizationalUnitResponse, *apiutils.APIError)

	// PatchOrganizationalUnit Patch the specified organizational unit.
	//  The complete updated attribute(s) of the organizational unit have to be provided in the request.
	//  Adding or removing entities from the OU is an asynchronous operation and has a task associated.
	//  When the request has entities to be added or removed, the response has a task ID
	//  which can be used to track the progress of the operation.
	PatchOrganizationalUnit(
		id string,
		embed *string,
		body *models.PatchOrganizationalUnitV1Request) (
		*models.PatchOrganizationalUnitV1ResponseWrapper, *apiutils.APIError)
}

OrganizationalUnitsV1Client represents a custom type interface

func NewOrganizationalUnitsV1

func NewOrganizationalUnitsV1(config config.Config) OrganizationalUnitsV1Client

NewOrganizationalUnitsV1 returns OrganizationalUnitsV1Client