Function getAll

See

https://docs.globus.org/globus-connect-server/v5.4/api/openapi_User_Credentials/#listUserCredentials

  • getAll(
        configuration: GCSConfiguration,
        options?: {
            query?: {
                include?: "all"[];
                marker?: string;
                page_size?: number;
                storage_gateway?: string;
            };
        } & {
            headers?: Headers;
            query?: {
                [key: string]: | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
            };
        },
        sdkOptions?: SDKOptions,
    ): Promise<
        JSONFetchResponse<
            {
                code?: "success";
                data?: {
                    connector_id?: string;
                    DATA_TYPE: "user_credential#1.0.0";
                    deleted?: boolean;
                    display_name?: null
                    | string;
                    home_directory?: string;
                    id?: string;
                    identity_id?: string;
                    invalid?: boolean;
                    policies?:
                        | {
                            DATA_TYPE: "s3_user_credential_policies#1.0.0";
                            s3_key_id?: null
                            | string;
                            s3_secret_key?: null | string;
                        }
                        | {
                            DATA_TYPE: "s3_user_credential_policies#1.1.0";
                            s3_key_id?: null
                            | string;
                            s3_requester_pays?: boolean;
                            s3_secret_key?: null | string;
                        }
                        | {
                            access_token?: null
                            | string;
                            DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            tid?: string;
                            token_expiry?: string;
                        }
                        | {
                            access_id?: string;
                            DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                            secret_key?: string;
                        }
                        | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                        | {
                            access_token?: null | string;
                            DATA_TYPE: "box_user_credential_policies#1.1.0";
                            email?: null | string;
                            max_upload?: number;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            token_expiry?: string;
                        }
                        | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                        | {
                            access_token?: null | string;
                            DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            root_info?: Record<(...), (...)>;
                            scopes?: (...)[];
                            sub?: null | string;
                            token_expiry?: string;
                        }
                        | {
                            access_token?: null
                            | string;
                            DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                            email?: string;
                            projects?: (...)[];
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: string;
                            token_expiry?: string;
                        }
                        | {
                            access_token?: null
                            | string;
                            DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            token_expiry?: string;
                        }
                        | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                        | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                        | {
                            access_token?: null | string;
                            DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            tid?: string;
                            token_expiry?: string;
                        }
                        | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                        | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
                    provisioned?: boolean;
                    storage_gateway_id?: string;
                    username?: string;
                }[];
            } & (
                | {
                    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?: {
              include?: "all"[];
              marker?: string;
              page_size?: number;
              storage_gateway?: string;
          };
      } & {
          headers?: Headers;
          query?: {
              [key: string]: | undefined
              | null
              | string
              | number
              | boolean
              | (undefined | null | string | number)[];
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<
        JSONFetchResponse<
            {
                code?: "success";
                data?: {
                    connector_id?: string;
                    DATA_TYPE: "user_credential#1.0.0";
                    deleted?: boolean;
                    display_name?: null
                    | string;
                    home_directory?: string;
                    id?: string;
                    identity_id?: string;
                    invalid?: boolean;
                    policies?:
                        | {
                            DATA_TYPE: "s3_user_credential_policies#1.0.0";
                            s3_key_id?: null
                            | string;
                            s3_secret_key?: null | string;
                        }
                        | {
                            DATA_TYPE: "s3_user_credential_policies#1.1.0";
                            s3_key_id?: null
                            | string;
                            s3_requester_pays?: boolean;
                            s3_secret_key?: null | string;
                        }
                        | {
                            access_token?: null
                            | string;
                            DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            tid?: string;
                            token_expiry?: string;
                        }
                        | {
                            access_id?: string;
                            DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                            secret_key?: string;
                        }
                        | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                        | {
                            access_token?: null | string;
                            DATA_TYPE: "box_user_credential_policies#1.1.0";
                            email?: null | string;
                            max_upload?: number;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            token_expiry?: string;
                        }
                        | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                        | {
                            access_token?: null | string;
                            DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            root_info?: Record<(...), (...)>;
                            scopes?: (...)[];
                            sub?: null | string;
                            token_expiry?: string;
                        }
                        | {
                            access_token?: null
                            | string;
                            DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                            email?: string;
                            projects?: (...)[];
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: string;
                            token_expiry?: string;
                        }
                        | {
                            access_token?: null
                            | string;
                            DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            token_expiry?: string;
                        }
                        | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                        | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                        | {
                            access_token?: null | string;
                            DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                            email?: null | string;
                            refresh_token?: null | string;
                            scopes?: (...)[];
                            sub?: null | string;
                            tid?: string;
                            token_expiry?: string;
                        }
                        | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                        | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
                    provisioned?: boolean;
                    storage_gateway_id?: string;
                    username?: string;
                }[];
            } & (
                | {
                    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