openai/resources/admin/organization/groups/roles.d.mts

The official TypeScript library for the OpenAI API

import { APIResource } from "../../../../core/resource.mjs";
import * as RolesAPI from "../roles.mjs";
import { APIPromise } from "../../../../core/api-promise.mjs";
import { NextCursorPage, type NextCursorPageParams, PagePromise } from "../../../../core/pagination.mjs";
import { RequestOptions } from "../../../../internal/request-options.mjs";
export declare class Roles extends APIResource {
    /**
     * Assigns an organization role to a group within the organization.
     *
     * @example
     * ```ts
     * const role =
     *   await client.admin.organization.groups.roles.create(
     *     'group_id',
     *     { role_id: 'role_id' },
     *   );
     * ```
     */
    create(groupID: string, body: RoleCreateParams, options?: RequestOptions): APIPromise<RoleCreateResponse>;
    /**
     * Retrieves an organization role assigned to a group.
     *
     * @example
     * ```ts
     * const role =
     *   await client.admin.organization.groups.roles.retrieve(
     *     'role_id',
     *     { group_id: 'group_id' },
     *   );
     * ```
     */
    retrieve(roleID: string, params: RoleRetrieveParams, options?: RequestOptions): APIPromise<RoleRetrieveResponse>;
    /**
     * Lists the organization roles assigned to a group within the organization.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const roleListResponse of client.admin.organization.groups.roles.list(
     *   'group_id',
     * )) {
     *   // ...
     * }
     * ```
     */
    list(groupID: string, query?: RoleListParams | null | undefined, options?: RequestOptions): PagePromise<RoleListResponsesPage, RoleListResponse>;
    /**
     * Unassigns an organization role from a group within the organization.
     *
     * @example
     * ```ts
     * const role =
     *   await client.admin.organization.groups.roles.delete(
     *     'role_id',
     *     { group_id: 'group_id' },
     *   );
     * ```
     */
    delete(roleID: string, params: RoleDeleteParams, options?: RequestOptions): APIPromise<RoleDeleteResponse>;
}
export type RoleListResponsesPage = NextCursorPage<RoleListResponse>;
/**
 * Role assignment linking a group to a role.
 */
export interface RoleCreateResponse {
    /**
     * Summary information about a group returned in role assignment responses.
     */
    group: RoleCreateResponse.Group;
    /**
     * Always `group.role`.
     */
    object: 'group.role';
    /**
     * Details about a role that can be assigned through the public Roles API.
     */
    role: RolesAPI.Role;
}
export declare namespace RoleCreateResponse {
    /**
     * Summary information about a group returned in role assignment responses.
     */
    interface Group {
        /**
         * Identifier for the group.
         */
        id: string;
        /**
         * Unix timestamp (in seconds) when the group was created.
         */
        created_at: number;
        /**
         * Display name of the group.
         */
        name: string;
        /**
         * Always `group`.
         */
        object: 'group';
        /**
         * Whether the group is managed through SCIM.
         */
        scim_managed: boolean;
    }
}
/**
 * Detailed information about a role assignment entry returned when listing
 * assignments.
 */
export interface RoleRetrieveResponse {
    /**
     * Identifier for the role.
     */
    id: string;
    /**
     * Principals from which the role assignment is inherited, when available.
     */
    assignment_sources: Array<RoleRetrieveResponse.AssignmentSource> | null;
    /**
     * When the role was created.
     */
    created_at: number | null;
    /**
     * Identifier of the actor who created the role.
     */
    created_by: string | null;
    /**
     * User details for the actor that created the role, when available.
     */
    created_by_user_obj: {
        [key: string]: unknown;
    } | null;
    /**
     * Description of the role.
     */
    description: string | null;
    /**
     * Arbitrary metadata stored on the role.
     */
    metadata: {
        [key: string]: unknown;
    } | null;
    /**
     * Name of the role.
     */
    name: string;
    /**
     * Permissions associated with the role.
     */
    permissions: Array<string>;
    /**
     * Whether the role is predefined by OpenAI.
     */
    predefined_role: boolean;
    /**
     * Resource type the role applies to.
     */
    resource_type: string;
    /**
     * When the role was last updated.
     */
    updated_at: number | null;
}
export declare namespace RoleRetrieveResponse {
    interface AssignmentSource {
        principal_id: string;
        principal_type: string;
    }
}
/**
 * Detailed information about a role assignment entry returned when listing
 * assignments.
 */
export interface RoleListResponse {
    /**
     * Identifier for the role.
     */
    id: string;
    /**
     * Principals from which the role assignment is inherited, when available.
     */
    assignment_sources: Array<RoleListResponse.AssignmentSource> | null;
    /**
     * When the role was created.
     */
    created_at: number | null;
    /**
     * Identifier of the actor who created the role.
     */
    created_by: string | null;
    /**
     * User details for the actor that created the role, when available.
     */
    created_by_user_obj: {
        [key: string]: unknown;
    } | null;
    /**
     * Description of the role.
     */
    description: string | null;
    /**
     * Arbitrary metadata stored on the role.
     */
    metadata: {
        [key: string]: unknown;
    } | null;
    /**
     * Name of the role.
     */
    name: string;
    /**
     * Permissions associated with the role.
     */
    permissions: Array<string>;
    /**
     * Whether the role is predefined by OpenAI.
     */
    predefined_role: boolean;
    /**
     * Resource type the role applies to.
     */
    resource_type: string;
    /**
     * When the role was last updated.
     */
    updated_at: number | null;
}
export declare namespace RoleListResponse {
    interface AssignmentSource {
        principal_id: string;
        principal_type: string;
    }
}
/**
 * Confirmation payload returned after unassigning a role.
 */
export interface RoleDeleteResponse {
    /**
     * Whether the assignment was removed.
     */
    deleted: boolean;
    /**
     * Identifier for the deleted assignment, such as `group.role.deleted` or
     * `user.role.deleted`.
     */
    object: string;
}
export interface RoleCreateParams {
    /**
     * Identifier of the role to assign.
     */
    role_id: string;
}
export interface RoleRetrieveParams {
    /**
     * The ID of the group to inspect.
     */
    group_id: string;
}
export interface RoleListParams extends NextCursorPageParams {
    /**
     * Sort order for the returned organization roles.
     */
    order?: 'asc' | 'desc';
}
export interface RoleDeleteParams {
    /**
     * The ID of the group to modify.
     */
    group_id: string;
}
export declare namespace Roles {
    export { type RoleCreateResponse as RoleCreateResponse, type RoleRetrieveResponse as RoleRetrieveResponse, type RoleListResponse as RoleListResponse, type RoleDeleteResponse as RoleDeleteResponse, type RoleListResponsesPage as RoleListResponsesPage, type RoleCreateParams as RoleCreateParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleListParams as RoleListParams, type RoleDeleteParams as RoleDeleteParams, };
}
//# sourceMappingURL=roles.d.mts.map