@rockcarver/frodo-lib/types/ops/OrganizationOps.d.ts

A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.

import { IdObjectSkeletonInterface } from '../api/ApiTypes';
import { State } from '../shared/State';
export type Organization = {
    /**
     * Get organization managed object type
     * @returns {string} organization managed object type in this realm
     */
    getRealmManagedOrganization(): string;
    /**
     * Read all organizations
     * @returns {Promise<IdObjectSkeletonInterface[]>} promise resolving to an array of organization objects
     */
    readOrganizations(): Promise<IdObjectSkeletonInterface[]>;
    /**
     * Get organizations
     * @returns {Promise<IdObjectSkeletonInterface[]>} promise resolving to an array of organization objects
     * @deprecated since v2.0.0 use {@link Organization.readOrganizations | readOrganizations} instead
     * ```javascript
     * readOrganizations(): Promise<IdObjectSkeletonInterface[]>
     * ```
     * @group Deprecated
     */
    getOrganizations(): Promise<IdObjectSkeletonInterface[]>;
};
declare const _default: (state: State) => Organization;
export default _default;
/**
 * Get organization managed object type
 * @returns {String} organization managed object type in this realm
 */
export declare function getRealmManagedOrganization({ state }: {
    state: State;
}): string;
/**
 * Read all organizations
 * @returns {Promise<IdObjectSkeletonInterface[]>} promise resolving to an object containing an array of organization objects
 */
export declare function readOrganizations({ state, }: {
    state: State;
}): Promise<IdObjectSkeletonInterface[]>;
export declare function listOrganizationsTopDown({ state }: {
    state: State;
}): Promise<any[]>;
//# sourceMappingURL=OrganizationOps.d.ts.map