organizationalunits

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 15, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package organizationalunits contains methods related to OrganizationalUnits

Package organizationalunits contains methods related to OrganizationalUnits

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 must be provided in
the request. Adding or removing entities from the OU is an asynchronous operation
and has an associated task. When the request has entities to be added or removed,
the response contains a task ID that 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 must be provided in
	//  the request. Adding or removing entities from the OU is an asynchronous operation
	//  and has an associated task. When the request has entities to be added or removed,
	//  the response contains a task ID that 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

type OrganizationalUnitsV2 added in v0.8.0 

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

OrganizationalUnitsV2 represents a custom type struct

func (*OrganizationalUnitsV2) CreateOrganizationalUnit added in v0.8.0 

func (o *OrganizationalUnitsV2) CreateOrganizationalUnit(
	embed *string,
	body *models.CreateOrganizationalUnitV2Request) (
	*models.CreateOrganizationalUnitResponseWrapper, *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 (*OrganizationalUnitsV2) DeleteOrganizationalUnit added in v0.8.0 

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

DeleteOrganizationalUnit Delete the specified organizational unit.

func (*OrganizationalUnitsV2) ListOrganizationalUnits added in v0.8.0 

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

ListOrganizationalUnits Returns a list of organizational units.

func (*OrganizationalUnitsV2) PatchOrganizationalUnit added in v0.8.0 

func (o *OrganizationalUnitsV2) PatchOrganizationalUnit(
	id string,
	embed *string,
	body *models.PatchOrganizationalUnitV2Request) (
	*models.PatchOrganizationalUnitResponseWrapper, *apiutils.APIError)

PatchOrganizationalUnit Patch the specified organizational unit. 

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

func (*OrganizationalUnitsV2) ReadOrganizationalUnit added in v0.8.0 

func (o *OrganizationalUnitsV2) ReadOrganizationalUnit(
	id string,
	embed *string) (
	*models.ReadOrganizationalUnitResponse, *apiutils.APIError)

ReadOrganizationalUnit Returns a representation of the specified organizational unit.

type OrganizationalUnitsV2Client added in v0.8.0 

type OrganizationalUnitsV2Client interface {
	// ListOrganizationalUnits Returns a list of organizational units.
	ListOrganizationalUnits(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListOrganizationalUnitsResponse, *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.CreateOrganizationalUnitV2Request) (
		*models.CreateOrganizationalUnitResponseWrapper, *apiutils.APIError)

	// ReadOrganizationalUnit Returns a representation of the specified organizational unit.
	ReadOrganizationalUnit(
		id string,
		embed *string) (
		*models.ReadOrganizationalUnitResponse, *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 must be provided in
	//  the request. Adding or removing entities from the OU is an asynchronous operation
	//  and has an associated task. When the request has entities to be added or removed,
	//  the response contains a task ID that can be used to track the progress of the
	//  operation.
	PatchOrganizationalUnit(
		id string,
		embed *string,
		body *models.PatchOrganizationalUnitV2Request) (
		*models.PatchOrganizationalUnitResponseWrapper, *apiutils.APIError)
}

OrganizationalUnitsV2Client represents a custom type interface

func NewOrganizationalUnitsV2 added in v0.8.0 

func NewOrganizationalUnitsV2(config config.Config) OrganizationalUnitsV2Client

NewOrganizationalUnitsV2 returns OrganizationalUnitsV2Client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.