Function getAll

See

https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Roles/#listRoles

  • getAll(
        configuration: GCSConfiguration,
        options?: {
            query?: {
                collection_id?: string;
                include?: "all_roles"[];
                marker?: string;
                page_size?: number;
            };
        } & {
            headers?: Headers;
            query?: {
                [key: string]: | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
            };
        },
        sdkOptions?: SDKOptions,
    ): Promise<
        JSONFetchResponse<
            {
                code?: "success";
                data?: {
                    collection?: null
                    | string;
                    DATA_TYPE: "role#1.0.0";
                    id?: string;
                    principal: string;
                    role:
                        | "owner"
                        | "administrator"
                        | "access_manager"
                        | "activity_manager"
                        | "activity_monitor"
                        | "access_monitor";
                }[];
            } & (
                | {
                    code: string;
                    data?: Record<string, unknown>[];
                    DATA_TYPE: "result#1.0.0";
                    detail?: unknown;
                    has_next_page?: boolean;
                    http_response_code: number;
                    marker?: null | string;
                    message?: string;
                }
                | {
                    authorization_parameters?: null
                    | { [key: string]: unknown };
                    code: string;
                    data?: Record<string, unknown>[];
                    DATA_TYPE: "result#1.1.0";
                    detail?: unknown;
                    has_next_page?: boolean;
                    http_response_code: number;
                    marker?: null | string;
                    message?: string;
                }
            ),
        >,
    >

  • Parameters

    • configuration: GCSConfiguration
    • Optionaloptions: {
          query?: {
              collection_id?: string;
              include?: "all_roles"[];
              marker?: string;
              page_size?: number;
          };
      } & {
          headers?: Headers;
          query?: {
              [key: string]: | undefined
              | null
              | string
              | number
              | boolean
              | (undefined | null | string | number)[];
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<
        JSONFetchResponse<
            {
                code?: "success";
                data?: {
                    collection?: null
                    | string;
                    DATA_TYPE: "role#1.0.0";
                    id?: string;
                    principal: string;
                    role:
                        | "owner"
                        | "administrator"
                        | "access_manager"
                        | "activity_manager"
                        | "activity_monitor"
                        | "access_monitor";
                }[];
            } & (
                | {
                    code: string;
                    data?: Record<string, unknown>[];
                    DATA_TYPE: "result#1.0.0";
                    detail?: unknown;
                    has_next_page?: boolean;
                    http_response_code: number;
                    marker?: null | string;
                    message?: string;
                }
                | {
                    authorization_parameters?: null
                    | { [key: string]: unknown };
                    code: string;
                    data?: Record<string, unknown>[];
                    DATA_TYPE: "result#1.1.0";
                    detail?: unknown;
                    has_next_page?: boolean;
                    http_response_code: number;
                    marker?: null | string;
                    message?: string;
                }
            ),
        >,
    >

Settings

Member Visibility