auth0/dist/cjs/management/__generated/managers/organizations-manager.d.ts

SDK for Auth0 API v2

import * as runtime from '../../../lib/runtime.js';
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
import type { DeleteMembersRequest, DeleteOrganizationMemberRolesRequest, GetEnabledConnections200ResponseOneOfInner, GetInvitations200ResponseOneOfInner, GetOrganizationClientGrants200ResponseOneOfInner, GetOrganizations200ResponseOneOfInner, PatchEnabledConnectionsByConnectionIdRequest, PatchOrganizationsByIdRequest, PostEnabledConnectionsRequest, PostInvitationsRequest, PostMembersRequest, PostOrganizationClientGrantsRequest, PostOrganizationMemberRolesRequest, PostOrganizations201Response, PostOrganizationsRequest, GetEnabledConnections200ResponseOneOf, GetInvitations200ResponseOneOf, GetMembers200ResponseOneOf, GetMembers200ResponseOneOfInner, GetOrganizationClientGrants200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetOrganizations200ResponseOneOf, DeleteClientGrantsByGrantIdRequest, DeleteEnabledConnectionsByConnectionIdRequest, DeleteInvitationsByInvitationIdRequest, DeleteMembersOperationRequest, DeleteOrganizationMemberRolesOperationRequest, DeleteOrganizationsByIdRequest, GetEnabledConnectionsRequest, GetEnabledConnectionsByConnectionIdRequest, GetInvitationsRequest, GetInvitationsByInvitationIdRequest, GetMembersRequest, GetNameByNameRequest, GetOrganizationClientGrantsRequest, GetOrganizationMemberRolesRequest, GetOrganizationsRequest, GetOrganizationsByIdRequest, PatchEnabledConnectionsByConnectionIdOperationRequest, PatchOrganizationsByIdOperationRequest, PostEnabledConnectionsOperationRequest, PostInvitationsOperationRequest, PostMembersOperationRequest, PostOrganizationClientGrantsOperationRequest, PostOrganizationMemberRolesOperationRequest } from '../models/index.js';
declare const BaseAPI: typeof runtime.BaseAPI;
/**
 *
 */
export declare class OrganizationsManager extends BaseAPI {
    /**
     * Remove a client grant from an organization
     *
     * @throws {RequiredError}
     */
    deleteClientGrantsByGrantId(requestParameters: DeleteClientGrantsByGrantIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Delete connections from an organization
     *
     * @throws {RequiredError}
     */
    deleteEnabledConnection(requestParameters: DeleteEnabledConnectionsByConnectionIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Delete an invitation to organization
     *
     * @throws {RequiredError}
     */
    deleteInvitation(requestParameters: DeleteInvitationsByInvitationIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Delete members from an organization
     *
     * @throws {RequiredError}
     */
    deleteMembers(requestParameters: DeleteMembersOperationRequest, bodyParameters: DeleteMembersRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Remove one or more roles from a given user in the context of the provided organization
     *
     * @throws {RequiredError}
     */
    deleteMemberRoles(requestParameters: DeleteOrganizationMemberRolesOperationRequest, bodyParameters: DeleteOrganizationMemberRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Delete a specific organization
     *
     * Delete organization
     *
     * @throws {RequiredError}
     */
    delete(requestParameters: DeleteOrganizationsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Get connections enabled for an organization
     *
     * @throws {RequiredError}
     */
    getEnabledConnections(requestParameters: GetEnabledConnectionsRequest & {
        include_totals: true;
    }, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOf>>;
    getEnabledConnections(requestParameters?: GetEnabledConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetEnabledConnections200ResponseOneOfInner>>>;
    /**
     * Get an enabled connection for an organization
     *
     * @throws {RequiredError}
     */
    getEnabledConnection(requestParameters: GetEnabledConnectionsByConnectionIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOfInner>>;
    /**
     * Get invitations to organization
     *
     * @throws {RequiredError}
     */
    getInvitations(requestParameters: GetInvitationsRequest & {
        include_totals: true;
    }, initOverrides?: InitOverride): Promise<ApiResponse<GetInvitations200ResponseOneOf>>;
    getInvitations(requestParameters?: GetInvitationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetInvitations200ResponseOneOfInner>>>;
    /**
     * Get an invitation to organization
     *
     * @throws {RequiredError}
     */
    getInvitation(requestParameters: GetInvitationsByInvitationIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetInvitations200ResponseOneOfInner>>;
    /**
     * List organization members.
     *
     * <ul>
     *   <li>
     *     Use the <code>fields</code> parameter to optionally define the specific member details retrieved. If
     *     <code>fields</code> is left blank, all fields (except roles) are returned.
     *   </li>
     *   <li>
     *     Member roles are not sent by default. Use <code>fields=roles</code> to retrieve the roles assigned to each listed
     *     member. To use this parameter, you must include the <code>read:organization_member_roles</code> scope in the token.
     *   </li>
     * </ul>
     *
     * This endpoint supports two types of pagination:
     *
     * - Offset pagination
     * - Checkpoint pagination
     *
     * Checkpoint pagination must be used if you need to retrieve more than 1000
     * organization members.
     *
     * <h2>Checkpoint Pagination</h2>
     *
     * To search by checkpoint, use the following parameters: - from: Optional id from which to start selection. - take: The
     * total amount of entries to retrieve when using the from parameter. Defaults to 50. Note: The first time you call this
     * endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter. If there are more results, a
     * <code>next</code> value will be included in the response. You can use this for subsequent API calls. When
     * <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
     *
     * Get members who belong to an organization
     *
     * @throws {RequiredError}
     */
    getMembers(requestParameters: GetMembersRequest & {
        include_totals: true;
    }, initOverrides?: InitOverride): Promise<ApiResponse<GetMembers200ResponseOneOf>>;
    getMembers(requestParameters?: GetMembersRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetMembers200ResponseOneOfInner>>>;
    /**
     * Retrieve details about a single Organization specified by name.
     *
     * Get organization by name
     *
     * @throws {RequiredError}
     */
    getByName(requestParameters: GetNameByNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
    /**
     * Get client grants associated to an organization
     *
     * @throws {RequiredError}
     */
    getOrganizationClientGrants(requestParameters: GetOrganizationClientGrantsRequest & {
        include_totals: true;
    }, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationClientGrants200ResponseOneOf>>;
    getOrganizationClientGrants(requestParameters?: GetOrganizationClientGrantsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizationClientGrants200ResponseOneOfInner>>>;
    /**
     * Get the roles assigned to an organization member
     *
     * @throws {RequiredError}
     */
    getMemberRoles(requestParameters: GetOrganizationMemberRolesRequest & {
        include_totals: true;
    }, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOf>>;
    getMemberRoles(requestParameters?: GetOrganizationMemberRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizationMemberRoles200ResponseOneOfInner>>>;
    /**
     * Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
     *
     * This endpoint supports two types of pagination:
     * <ul>
     * <li>Offset pagination</li>
     * <li>Checkpoint pagination</li>
     * </ul>
     *
     * Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
     *
     * <h2>Checkpoint Pagination</h2>
     *
     * To search by checkpoint, use the following parameters:
     * <ul>
     * <li><code>from</code>: Optional id from which to start selection.</li>
     * <li><code>take</code>: The total number of entries to retrieve when using the <code>from</code> parameter. Defaults to 50.</li>
     * </ul>
     *
     * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
     *
     * Get organizations
     *
     * @throws {RequiredError}
     */
    getAll(requestParameters: GetOrganizationsRequest & {
        include_totals: true;
    }, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOf>>;
    getAll(requestParameters?: GetOrganizationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizations200ResponseOneOfInner>>>;
    /**
     * Retrieve details about a single Organization specified by ID.
     *
     * Get organization
     *
     * @throws {RequiredError}
     */
    get(requestParameters: GetOrganizationsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
    /**
     * Modify an enabled_connection belonging to an Organization.
     *
     * Modify an Organizations Connection
     *
     * @throws {RequiredError}
     */
    updateEnabledConnection(requestParameters: PatchEnabledConnectionsByConnectionIdOperationRequest, bodyParameters: PatchEnabledConnectionsByConnectionIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOfInner>>;
    /**
     * Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
     *
     * Modify an Organization
     *
     * @throws {RequiredError}
     */
    update(requestParameters: PatchOrganizationsByIdOperationRequest, bodyParameters: PatchOrganizationsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOfInner>>;
    /**
     * Add connections to an organization
     *
     * @throws {RequiredError}
     */
    addEnabledConnection(requestParameters: PostEnabledConnectionsOperationRequest, bodyParameters: PostEnabledConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEnabledConnections200ResponseOneOfInner>>;
    /**
     * Create invitations to organization
     *
     * @throws {RequiredError}
     */
    createInvitation(requestParameters: PostInvitationsOperationRequest, bodyParameters: PostInvitationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetInvitations200ResponseOneOfInner>>;
    /**
     * Add members to an organization
     *
     * @throws {RequiredError}
     */
    addMembers(requestParameters: PostMembersOperationRequest, bodyParameters: PostMembersRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Associate a client grant with an organization
     *
     * @throws {RequiredError}
     */
    postOrganizationClientGrants(requestParameters: PostOrganizationClientGrantsOperationRequest, bodyParameters: PostOrganizationClientGrantsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationClientGrants200ResponseOneOfInner>>;
    /**
     * Assign one or more roles to a given user that will be applied in the context of the provided organization
     *
     * @throws {RequiredError}
     */
    addMemberRoles(requestParameters: PostOrganizationMemberRolesOperationRequest, bodyParameters: PostOrganizationMemberRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
    /**
     * Create a new Organization within your tenant.  To learn more about Organization settings, behavior, and configuration options, review <a href="https://auth0.com/docs/manage-users/organizations/create-first-organization">Create Your First Organization</a>.
     *
     * Create an Organization
     *
     * @throws {RequiredError}
     */
    create(bodyParameters: PostOrganizationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostOrganizations201Response>>;
}
export {};