Class OrganizationTemplatesClient

Index

Constructors

constructor

new OrganizationTemplatesClient(
options: BaseClientOptions,
): OrganizationTemplatesClient
Parameters
- options: BaseClientOptions
Returns OrganizationTemplatesClient

Methods

list

list(
    request?: ListOrganizationTemplatesRequestParameters,
    requestOptions?: OrganizationTemplatesClient.RequestOptions,
): Promise<
    Page<
        OrganizationTemplate,
        ListOrganizationTemplatesPaginatedResponseContent,
    >,
>
Retrieve a list of Organization Templates. This endpoint supports Checkpoint pagination. Results are returned in a stable order, sorted by their identifier (id) in ascending order.
Parameters
- request: ListOrganizationTemplatesRequestParameters = {}
- OptionalrequestOptions: OrganizationTemplatesClient.RequestOptions
  Request-specific configuration.
Returns Promise<
    Page<
        OrganizationTemplate,
        ListOrganizationTemplatesPaginatedResponseContent,
    >,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizationTemplates.list({
        from: "from",
        take: 1
    })
```

create

create(
request: CreateOrganizationTemplateRequestContent,
requestOptions?: OrganizationTemplatesClient.RequestOptions,
): HttpResponsePromise<OrganizationTemplate>
Create an Organization Template.
Parameters
- request: CreateOrganizationTemplateRequestContent
- OptionalrequestOptions: OrganizationTemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<OrganizationTemplate>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.organizationTemplates.create({
        name: "name",
        organization_deletion_behavior: "allow",
        enforce_permission_ceiling: true,
        enforce_self_assignment_restriction: true
    })
```

get

get(
id: string,
requestOptions?: OrganizationTemplatesClient.RequestOptions,
): HttpResponsePromise<OrganizationTemplate>
Retrieve details about a single Organization Template specified by ID.
Parameters
- id: string
  Organization Template identifier.
- OptionalrequestOptions: OrganizationTemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<OrganizationTemplate>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizationTemplates.get("id")
```

update

update(
    id: string,
    request?: UpdateOrganizationTemplateRequestContent,
    requestOptions?: OrganizationTemplatesClient.RequestOptions,
): HttpResponsePromise<OrganizationTemplate>
Update the details of a specific Organization Template.
Parameters
- id: string
  Organization Template identifier.
- request: UpdateOrganizationTemplateRequestContent = {}
- OptionalrequestOptions: OrganizationTemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<OrganizationTemplate>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizationTemplates.update("id")
```

listOrganizations

listOrganizations(
    id: string,
    request?: ListTemplateOrganizationsRequestParameters,
    requestOptions?: OrganizationTemplatesClient.RequestOptions,
): Promise<
    Page<
        OrganizationTemplateAssignedOrganization,
        ListTemplateOrganizationsPaginatedResponseContent,
    >,
>
Retrieve a list of organizations assigned to an Organization Template. This endpoint supports Checkpoint pagination. Results are returned in a stable order, sorted by their identifier (id) in ascending order.
Parameters
- id: string
  The ID of the organization template.
- request: ListTemplateOrganizationsRequestParameters = {}
- OptionalrequestOptions: OrganizationTemplatesClient.RequestOptions
  Request-specific configuration.
Returns Promise<
    Page<
        OrganizationTemplateAssignedOrganization,
        ListTemplateOrganizationsPaginatedResponseContent,
    >,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizationTemplates.listOrganizations("id", {
        from: "from",
        take: 1
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class OrganizationTemplatesClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns OrganizationTemplatesClient

Methods

list

Parameters

Returns Promise< Page< OrganizationTemplate, ListOrganizationTemplatesPaginatedResponseContent, >,>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<OrganizationTemplate>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<OrganizationTemplate>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<OrganizationTemplate>

Throws

Throws

Throws

Throws

Throws

Example

listOrganizations

Parameters

Returns Promise< Page< OrganizationTemplateAssignedOrganization, ListTemplateOrganizationsPaginatedResponseContent, >,>

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

Returns Promise<
Page<
OrganizationTemplate,
ListOrganizationTemplatesPaginatedResponseContent,
>,
>

Returns Promise<
Page<
OrganizationTemplateAssignedOrganization,
ListTemplateOrganizationsPaginatedResponseContent,
>,
>

`Protected` `Readonly`_options