Globus Connect Server API#

The Globus Connect Server Manager API (GCS Manager API) runs on a Globus Connect Server Endpoint and allows management of the Endpoint, Storage Gateways, Collections, and other resources.

Unlike other Globus services, there is no single central API used to contact GCS Manager instances. Therefore, the GCSClient is always initialized with the FQDN (DNS name) of the GCS Endpoint. e.g. gcs = GCSClient("abc.def.data.globus.org")

Client#

The primary interface for the GCS Manager API is the GCSClient class.

class globus_sdk.GCSClient(gcs_address: str, *, environment: str | None = None, authorizer: GlobusAuthorizer | None = None, app_name: str | None = None, transport_params: dict[str, Any] | None = None)[source]#

Bases: BaseClient

A GCSClient provides communication with the GCS Manager API of a Globus Connect Server instance. For full reference, see the documentation for the GCS Manager API.

Unlike other client types, this must be provided with an address for the GCS Manager. All other arguments are the same as those for BaseClient.

Parameters:

gcs_address (str) – The FQDN (DNS name) or HTTPS URL for the GCS Manager API.

Methods

static get_gcs_endpoint_scopes(endpoint_id: UUID | str) → GCSEndpointScopeBuilder[source]#

Given a GCS Endpoint ID, this helper constructs an object containing the scopes for that Endpoint.

Parameters:

endpoint_id (UUID or str) – The ID of the Endpoint

See documentation for globus_sdk.scopes.GCSEndpointScopeBuilder for more information.

static get_gcs_collection_scopes(collection_id: UUID | str) → GCSCollectionScopeBuilder[source]#

Given a GCS Collection ID, this helper constructs an object containing the scopes for that Collection.

Parameters:

collection_id (UUID or str) – The ID of the Collection

See documentation for globus_sdk.scopes.GCSCollectionScopeBuilder for more information.

static connector_id_to_name(connector_id: UUID | str) → str | None[source]#

Helper that converts a given connector_id into a human readable connector name string. Will return None if the id is not recognized.

Note that it is possible for valid connector_ids to be unrecognized due to differing SDK and GCS versions.

Parameters:

connector_id (UUID or str) – The ID of the connector

get_collection_list(*, mapped_collection_id: UUID | str | None = None, filter: Iterable[str] | str | None = None, include: Iterable[str] | str | None = None, page_size: int | None = None, marker: str | None = None, query_params: dict[str, Any] | None = None) → IterableGCSResponse[source]#

List the Collections on an Endpoint

Parameters:

  • mapped_collection_id (str or UUID) – Filter collections which were created using this mapped collection ID.

  • filter (str or iterable of str, optional) – Filter the returned set to any combination of the following: mapped_collections, guest_collections, managed_by_me, created_by_me.

  • include (str or iterable of str, optional) – Names of additional documents to include in the response

  • page_size (int, optional) – Number of results to return per page

  • marker (str, optional) – Pagination marker supplied by previous API calls in the event a request returns more values than the page size

  • query_params (dict, optional) – Additional passthrough query parameters

GET /collections

See List Collections in the API documentation for details.

get_collection(collection_id: UUID | str, *, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Lookup a Collection on an Endpoint

Parameters:

  • collection_id (str or UUID) – The ID of the collection to lookup

  • query_params (dict, optional) – Additional passthrough query parameters

GET /collections/{collection_id}

See Get Collection in the API documentation for details.

create_collection(collection_data: dict[str, Any] | CollectionDocument) → UnpackingGCSResponse[source]#

Create a collection. This is used to create either a mapped or a guest collection. When created, a collection:administrator role for that collection will be created using the caller’s identity.

In order to create a guest collection, the caller must have an identity that matches the Storage Gateway policies.

In order to create a mapped collection, the caller must have an endpoint:administrator or endpoint:owner role.

Parameters:

collection_data (dict or CollectionDocument) – The collection document for the new collection

POST /collections

See Create Collection in the API documentation for details.

update_collection(collection_id: UUID | str, collection_data: dict[str, Any] | CollectionDocument, *, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Update a Collection

Parameters:

  • collection_id (str or UUID) – The ID of the collection to update

  • collection_data (dict or CollectionDocument) – The collection document for the modified collection

  • query_params (dict, optional) – Additional passthrough query parameters

PATCH /collections/{collection_id}

See Update Collection in the API documentation for details.

delete_collection(collection_id: UUID | str, *, query_params: dict[str, Any] | None = None) → GlobusHTTPResponse[source]#

Delete a Collection

Parameters:

  • collection_id (str or UUID) – The ID of the collection to delete

  • query_params (dict, optional) – Additional passthrough query parameters

DELETE /collections/{collection_id}

See Delete Collection in the API documentation for details.

get_storage_gateway_list(*, include: None | str | Iterable[str] = None, page_size: int | None = None, marker: str | None = None, query_params: dict[str, Any] | None = None) → IterableGCSResponse[source]#

List Storage Gateways

Parameters:

  • include (str or iterable of str, optional) – Optional document types to include in the response. If ‘private_policies’ is included, then include private storage gateway policies in the attached storage_gateways document. This requires an administrator role on the Endpoint.

  • page_size (int, optional) – Number of results to return per page

  • marker (str, optional) – Pagination marker supplied by previous API calls in the event a request returns more values than the page size

  • query_params (dict, optional) – Additional passthrough query parameters

This method supports paginated access. To use the paginated variant, give the same arguments as normal, but prefix the method name with paginated, as in

client.paginated.get_storage_gateway_list(...)

For more information, see how to make paginated calls.

GET /storage_gateways

See Delete Collection in the API documentation for details.

create_storage_gateway(data: dict[str, Any] | StorageGatewayDocument, *, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Create a Storage Gateway

Parameters:

  • data (dict or StorageGatewayDocument) – Data in the format of a Storage Gateway document, it is recommended to use the StorageGatewayDocument class to construct this data.

  • query_params (dict, optional) – Additional passthrough query parameters

POST /storage_gateways

See Create Storage Gateway in the API documentation for details.

get_storage_gateway(storage_gateway_id: UUID | str, *, include: None | str | Iterable[str] = None, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Lookup a Storage Gateway by ID

Parameters:

  • storage_gateway_id (str or UUID) – UUID for the Storage Gateway to be gotten

  • include (str or iterable of str, optional) – Optional document types to include in the response. If ‘private_policies’ is included, then include private storage gateway policies in the attached storage_gateways document. This requires an administrator role on the Endpoint.

  • query_params (dict, optional) – Additional passthrough query parameters

GET /storage_gateways/<storage_gateway_id>

See Get a Storage Gateway in the API documentation for details.

update_storage_gateway(storage_gateway_id: UUID | str, data: dict[str, Any] | StorageGatewayDocument, *, query_params: dict[str, Any] | None = None) → GlobusHTTPResponse[source]#

Update a Storage Gateway

Parameters:

  • storage_gateway_id (str or UUID) – UUID for the Storage Gateway to be updated

  • data (dict or StorageGatewayDocument) – Data in the format of a Storage Gateway document, it is recommended to use the StorageGatewayDocument class to construct this data.

  • query_params (dict, optional) – Additional passthrough query parameters

PATCH /storage_gateways/<storage_gateway_id>

See Update a Storage Gateway in the API documentation for details.

delete_storage_gateway(storage_gateway_id: str | UUID, *, query_params: dict[str, Any] | None = None) → GlobusHTTPResponse[source]#

Delete a Storage Gateway

Parameters:

  • storage_gateway_id (str or UUID) – UUID for the Storage Gateway to be deleted

  • query_params (dict, optional) – Additional passthrough query parameters

DELETE /storage_gateways/<storage_gateway_id>

See Delete a Storage Gateway in the API documentation for details.

get_role_list(collection_id: UUID | str | None = None, include: str | None = None, page_size: int | None = None, marker: str | None = None, query_params: dict[str, Any] | None = None) → IterableGCSResponse[source]#

List Roles

Parameters:

  • collection_id (str or UUID, optional) – UUID of a Collection. If given then only roles related to that Collection are returned, otherwise only Endpoint roles are returned.

  • include (str, optional) – Pass “all_roles” to request all roles all roles relevant to the resource instead of only those the caller has on the resource

  • page_size (int, optional) – Number of results to return per page

  • marker (str, optional) – Pagination marker supplied by previous API calls in the event a request returns more values than the page size

  • query_params (dict, optional) – Additional passthrough query parameters

GET /roles

See Delete a Storage Gateway in the API documentation for details.

create_role(data: dict[str, Any] | GCSRoleDocument, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Create a Role

Parameters:

  • data (dict) – Data in the format of a Role document, it is recommended to use the GCSRoleDocument class to construct this data.

  • query_params (dict, optional) – Additional passthrough query parameters

POST /roles

See Create Role in the API documentation for details.

get_role(role_id: UUID | str, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Get a Role by ID

Parameters:

  • role_id (str or UUID) – UUID for the Role to be gotten

  • query_params (dict, optional) – Additional passthrough query parameters

GET /roles/{role_id}

See Get Role in the API documentation for details.

delete_role(role_id: UUID | str, query_params: dict[str, Any] | None = None) → GlobusHTTPResponse[source]#

Delete a Role

Parameters:

  • role_id (str or UUID) – UUID for the Role to be deleted

  • query_params (dict, optional) – Additional passthrough query parameters

DELETE /roles/{role_id}

See Delete Role in the API documentation for details.

get_user_credential_list(storage_gateway: UUID | str | None = None, query_params: dict[str, Any] | None = None, page_size: int | None = None, marker: str | None = None) → IterableGCSResponse[source]#

List User Credentials

Parameters:

  • storage_gateway (str or UUID, optional) – UUID of a storage gateway to limit results to

  • query_params (dict, optional) – Additional passthrough query parameters

  • page_size (int, optional) – Number of results to return per page

  • marker (str, optional) – Pagination marker supplied by previous API calls in the event a request returns more values than the page size

GET /user_credentials

See Get User Credential List in the API documentation for details.

create_user_credential(data: dict[str, Any] | UserCredentialDocument, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Create a User Credential

Parameters:

  • data (dict) – Data in the format of a UserCredential document, it is recommended to use the UserCredential class to construct this

  • query_params (dict, optional) – Additional passthrough query parameters

POST /user_credentials

See Create User Credential in the API documentation for details.

get_user_credential(user_credential_id: UUID | str, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Get a User Credential by ID

Parameters:

  • user_credential_id (str or UUID) – UUID for the UserCredential to be gotten

  • query_params (dict, optional) – Additional passthrough query parameters

GET /user_credentials/{user_credential_id}

See Get a User Credential in the API documentation for details.

update_user_credential(user_credential_id: UUID | str, data: dict[str, Any] | UserCredentialDocument, query_params: dict[str, Any] | None = None) → UnpackingGCSResponse[source]#

Update a User Credential

Parameters:

  • user_credential_id (str or UUID) – UUID for the UserCredential to be updated

  • data (dict) – Data in the format of a UserCredential document, it is recommended to use the UserCredential class to construct this

  • query_params (dict, optional) – Additional passthrough query parameters

PATCH /user_credentials/{user_credential_id}

See Update a User Credential in the API documentation for details.

delete_user_credential(user_credential_id: UUID | str, query_params: dict[str, Any] | None = None) → GlobusHTTPResponse[source]#

Delete a User Credential

Parameters:

  • user_credential_id (str or UUID) – UUID for the UserCredential to be deleted

  • query_params (dict, optional) – Additional passthrough query parameters

DELETE /user_credentials/{user_credential_id}

See Delete User Credential in the API documentation for details.

Helper Objects#

class globus_sdk.services.gcs.data.ActiveScaleStoragePolicies(DATA_TYPE: str = 's3_storage_policies#1.0.0', s3_endpoint: str | None = None, s3_buckets: Iterable[str] | None = None, s3_user_credential_required: bool | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: S3StoragePolicies

The ActiveScale Storage Policy is an alias for the S3 Storage Policy. It even uses S3 policy DATA_TYPE.

class globus_sdk.services.gcs.data.AzureBlobStoragePolicies(DATA_TYPE: str = 'azure_blob_storage_policies#1.0.0', client_id: str | None = None, secret: str | None = None, tenant: str | None = None, account: str | None = None, auth_type: str | None = None, adls: bool | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a Azure Blob Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • client_id (str) – Client ID registered with the MS Application console to access Azure Blob Private.

  • secret (str) – Secret created to access access MS with the client_id in this policy. Private.

  • tenant (str) – MS Tenant ID from which to allow user logins. Private.

  • account (str) – Azure Storage account. Private.

  • auth_type (str) – Auth type: user, service_principal or user_service_principal

  • adls (bool) – ADLS support enabled or not. Private.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.BlackPearlStoragePolicies(DATA_TYPE: str = 'blackpearl_storage_policies#1.0.0', s3_endpoint: str | None = None, bp_access_id_file: str | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a BlackPearl Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument.

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • s3_endpoint (str) – The URL of the S3 endpoint of the BlackPearl appliance to use to access collections on this Storage Gateway.

  • bp_access_id_file (str) – Path to the file which provides mappings from usernames within the configured identity domain to the ID and secret associated with the user’s BlackPearl account

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.BoxStoragePolicies(DATA_TYPE: str = 'box_storage_policies#1.0.0', enterpriseID: str | None = None, boxAppSettings: dict[str, Any] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a Box Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • enterpriseID (str) – Identifies which Box Enterprise this Storage Gateway is authorized to access. Private.

  • boxAppSettings (dict) – Values that the Storage Gateway uses to identify and authenticate with the Box API. Private.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.CephStoragePolicies(DATA_TYPE: str = 'ceph_storage_policies#1.0.0', s3_endpoint: str | None = None, s3_buckets: Iterable[str] | None = None, ceph_admin_key_id: str | None = None, ceph_admin_secret_key: str | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a Ceph Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • s3_endpoint (str) – URL of the S3 API endpoint

  • s3_buckets (iterable of str) – List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this Storage Gateway.

  • ceph_admin_key_id (str) – Administrator key id used to authenticate with the ceph admin service to obtain user credentials. Private.

  • ceph_admin_secret_key (str) – Administrator secret key used to authenticate with the ceph admin service to obtain user credentials. Private.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.CollectionDocument(*, data_type: str | None = None, collection_base_path: str | None = None, contact_email: str | None = None, contact_info: str | None = None, default_directory: str | None = None, department: str | None = None, description: str | None = None, display_name: str | None = None, identity_id: UUID | str | None = None, info_link: str | None = None, organization: str | None = None, user_message: str | None = None, user_message_link: str | None = None, keywords: Iterable[str] | None = None, disable_verify: bool | None = None, enable_https: bool | None = None, force_encryption: bool | None = None, force_verify: bool | None = None, public: bool | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: PayloadWrapper, ABC

This is the base class for MappedCollectionDocument and GuestCollectionDocument.

Parameters common to both of those are defined and documented here.

Parameters:

  • data_type (str, optional) – Explicitly set the DATA_TYPE value for this collection. Normally DATA_TYPE is deduced from the provided parameters and should not be set. To maximize compatibility with different versions of GCS, only set this value when necessary.

  • collection_base_path (str, optional) – The location of the collection on its underlying storage. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a path relative to the value of the root_path attribute on the mapped collection identified by the mapped_collection_id. This parameter is optional for updates but required when creating a new collection.

  • contact_email (str, optional) – Email address of the support contact for the collection

  • contact_info (str, optional) – Other contact information for the collection, e.g. phone number or mailing address

  • default_directory (str, optional) – Default directory when using the collection

  • department (str, optional) – The department which operates the collection

  • description (str, optional) – A text description of the collection

  • display_name (str, optional) – Friendly name for the collection

  • identity_id (str or UUID, optional) – The Globus Auth identity which acts as the owner of the collection

  • info_link (str, optional) – Link for more info about the collection

  • organization (str, optional) – The organization which maintains the collection

  • user_message (str, optional) – A message to display to users when interacting with this collection

  • user_message_link (str, optional) – A link to additional messaging for users when interacting with this collection

  • keywords (iterable of str, optional) – A list of keywords used to help searches for the collection

  • disable_verify (bool, optional) – Disable verification checksums on transfers to and from this collection

  • enable_https (bool, optional) – Enable or disable HTTPS support (requires a managed endpoint)

  • force_encryption (bool, optional) – When set to True, all transfers to and from the collection are always encrypted

  • force_verify (bool, optional) – Force verification checksums on transfers to and from this collection

  • public (bool, optional) – If True, the collection will be visible to other Globus users

  • additional_fields (dict, optional) – Additional data for inclusion in the collection document

class globus_sdk.services.gcs.data.CollectionPolicies(dict=None, /, **kwargs)[source]#

Bases: PayloadWrapper, ABC

This is the abstract base type for Collection Policies documents to use as the policies parameter when creating a MappedCollectionDocument.

class globus_sdk.services.gcs.data.GCSRoleDocument(DATA_TYPE: str = 'role#1.0.0', collection: UUID | str | None = None, principal: str | None = None, role: str | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: PayloadWrapper

Convenience class for constructing a Role document to use as the data parameter to create_role

Parameters:

  • DATA_TYPE (str) – Versioned document type.

  • collection (str or UUID, optional) – Collection ID for the collection the role will apply to. This value is omitted when creating an endpoint role or when creating role definitions when creating collections.

  • principal (str, optional) – Auth identity or group id URN. Should be in the format urn:globus:auth:[identity|group]:{uuid of identity or group}

  • role (str, optional) – Role assigned to the principal. Known values are owner, administrator, access_manager, activity_manager, and activity_monitor

class globus_sdk.services.gcs.data.GoogleCloudStorageCollectionPolicies(DATA_TYPE: str = 'google_cloud_storage_collection_policies#1.0.0', project: str | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: CollectionPolicies

Convenience class for constructing a Google Cloud Storage Collection Policy document to use as the policies parameter when creating a CollectionDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • project (str, optional) – Google Cloud Platform project ID that is used by this collection

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.GoogleCloudStoragePolicies(DATA_TYPE: str = 'google_cloud_storage_policies#1.0.0', client_id: str | None = None, secret: str | None = None, service_account_key: dict[str, Any] | None = None, buckets: Iterable[str] | None = None, projects: Iterable[str] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a Google Cloud Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • client_id (str) – Client ID registered with the Google Application console to access Google Drive. Private.

  • secret (str) – Secret created to access access Google Drive with the client_id in this policy. Private.

  • service_account_key (dict) – Credentials for use with service account auth, read from a Google-provided json file. Private.

  • buckets (iterable of str) – The list of Google Cloud Storage buckets which the Storage Gateway is allowed to access, as well as the list of buckets that will be shown in root level directory listings. If this list is unset, bucket access is unrestricted and all non public credential accessible buckets will be shown in root level directory listings. The value is a list of bucket names.

  • projects (iterable of str) – The list of Google Cloud Storage projects which the Storage Gateway is allowed to access. If this list is unset, project access is unrestricted. The value is a list of project id strings.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.GoogleDriveStoragePolicies(DATA_TYPE: str = 'google_drive_storage_policies#1.0.0', client_id: str | None = None, secret: str | None = None, user_api_rate_quota: int | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a Google Drive Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • client_id (str) – Client ID registered with the Google Application console to access Google Drive. Private.

  • secret (str) – Secret created to access access Google Drive with the client_id in this policy. Private.

  • user_api_rate_quota (int) – User API Rate quota associated with this client ID.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.GuestCollectionDocument(*, data_type: str | None = None, collection_base_path: str | None = None, contact_email: str | None = None, contact_info: str | None = None, default_directory: str | None = None, department: str | None = None, description: str | None = None, display_name: str | None = None, identity_id: UUID | str | None = None, info_link: str | None = None, organization: str | None = None, user_message: str | None = None, user_message_link: str | None = None, keywords: Iterable[str] | None = None, disable_verify: bool | None = None, enable_https: bool | None = None, force_encryption: bool | None = None, force_verify: bool | None = None, public: bool | None = None, mapped_collection_id: UUID | str | None = None, user_credential_id: UUID | str | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: CollectionDocument

An object used to represent a Guest Collection for creation or update operations. The initializer supports all writable fields on Guest Collections but does not include read-only fields like id.

Because these documents may be used for updates, no fields are strictly required. However, GCS will require the following fields for creation:

  • mapped_collection_id

  • user_credential_id

  • collection_base_path

All parameters for CollectionDocument are supported in addition to the parameters below.

Parameters:

  • mapped_collection_id (str or UUID) – The ID of the mapped collection which hosts this guest collection

  • user_credential_id (str or UUID) – The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection’s identity_id.

class globus_sdk.services.gcs.data.HPSSStoragePolicies(DATA_TYPE: str = 'hpss_storage_policies#1.0.0', authentication_mech: str | None = None, authenticator: str | None = None, uda_checksum_support: bool | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a HPSS Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • authentication_mech (str) – Authentication mechanism to use with HPSS.

  • authenticator (str) – Authentication credentials to use with HPSS.

  • uda_checksum_support (bool) – Flag indicating whether checksums should be stored in metadata.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.IrodsStoragePolicies(DATA_TYPE: str = 'irods_storage_policies#1.0.0', irods_environment_file: str | None = None, irods_authentication_file: str | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing an iRODS Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • irods_environment_file (str) – Path to iRODS environment file on the endpoint

  • irods_authentication_file (str) – Path to iRODS authentication file on the endpoint

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.MappedCollectionDocument(*, data_type: str | None = None, collection_base_path: str | None = None, contact_email: str | None = None, contact_info: str | None = None, default_directory: str | None = None, department: str | None = None, description: str | None = None, display_name: str | None = None, identity_id: UUID | str | None = None, info_link: str | None = None, organization: str | None = None, user_message: str | None = None, user_message_link: str | None = None, keywords: Iterable[str] | None = None, disable_verify: bool | None = None, enable_https: bool | None = None, force_encryption: bool | None = None, force_verify: bool | None = None, public: bool | None = None, domain_name: str | None = None, guest_auth_policy_id: UUID | str | None = None, storage_gateway_id: UUID | str | None = None, sharing_users_allow: Iterable[str] | None = None, sharing_users_deny: Iterable[str] | None = None, sharing_restrict_paths: dict[str, Any] | None = None, allow_guest_collections: bool | None = None, disable_anonymous_writes: bool | None = None, policies: CollectionPolicies | dict[str, Any] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: CollectionDocument

An object used to represent a Mapped Collection for creation or update operations. The initializer supports all writable fields on Mapped Collections but does not include read-only fields like id.

Because these documents may be used for updates, no fields are strictly required. However, GCS will require the following fields for creation:

  • storage_gateway_id

  • collection_base_path

All parameters for CollectionDocument are supported in addition to the parameters below.

Parameters:

  • storage_gateway_id (str or UUID, optional) – The ID of the storage gateway which hosts this mapped collection. This parameter is required when creating a collection.

  • domain_name (str, optional) – DNS name of the virtual host serving this collection

  • guest_auth_policy_id (UUID or str, optional) – Globus Auth policy ID to set on a mapped collection which is then inherited by its guest collections.

  • sharing_users_allow (iterable of str, optional) – Connector-specific usernames allowed to create guest collections

  • sharing_users_deny (iterable of str, optional) – Connector-specific usernames forbidden from creating guest collections

  • allow_guest_collections (bool, optional) – Enable or disable creation and use of Guest Collections on this Mapped Collection

  • disable_anonymous_writes (bool, optional) – Allow anonymous write ACLs on Guest Collections attached to this Mapped Collection. This option is only usable on non high-assurance collections

  • policies (dict, optional) – Connector-specific collection policies

  • sharing_restrict_paths (dict, optional) – A PathRestrictions document

class globus_sdk.services.gcs.data.OneDriveStoragePolicies(DATA_TYPE: str = 'onedrive_storage_policies#1.0.0', client_id: str | None = None, secret: str | None = None, tenant: str | None = None, user_api_rate_limit: int | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a OneDrive Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • client_id (str) – Client ID registered with the MS Application console to access OneDrive. Private.

  • secret (str) – Secret created to access access MS with the client_id in this policy. Private.

  • tenant (str or None) – MS Tenant ID from which to allow user logins. Private.

  • user_api_rate_limit (int) – User API Rate limit associated with this client ID.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.POSIXCollectionPolicies(DATA_TYPE: str = 'posix_collection_policies#1.0.0', sharing_groups_allow: None | str | Iterable[str] = None, sharing_groups_deny: None | str | Iterable[str] = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: CollectionPolicies

Convenience class for constructing a Posix Collection Policy document to use as the policies parameter when creating a CollectionDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • sharing_groups_allow (iterable of str, optional) – POSIX groups which are allowed to create guest collections.

  • sharing_groups_deny (iterable of str, optional) – POSIX groups which are not allowed to create guest collections.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.POSIXStagingCollectionPolicies(DATA_TYPE: str = 'posix_staging_collection_policies#1.0.0', sharing_groups_allow: None | str | Iterable[str] = None, sharing_groups_deny: None | str | Iterable[str] = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: CollectionPolicies

Convenience class for constructing a Posix Staging Collection Policy document to use as the policies parameter when creating a CollectionDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • sharing_groups_allow (iterable of str, optional) – POSIX groups which are allowed to create guest collections.

  • sharing_groups_deny (iterable of str, optional) – POSIX groups which are not allowed to create guest collections.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.POSIXStagingStoragePolicies(DATA_TYPE: str = 'posix_staging_storage_policies#1.0.0', groups_allow: Iterable[str] | None = None, groups_deny: Iterable[str] | None = None, stage_app: str | None = None, environment: Iterable[dict[str, str]] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a POSIX Staging Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • groups_allow (iterable of str, optional) – List of POSIX group IDs allowed to access this Storage Gateway. Private.

  • groups_deny (iterable of str, optional) – List of POSIX group IDs denied access this Storage Gateway. Private.

  • stage_app (str, optional) – Path to the stage app. Private.

  • environment (iterable of dict, optional) – A mapping of variable names to values to set in the environment when executing the stage_app. Private.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.POSIXStoragePolicies(DATA_TYPE: str = 'posix_storage_policies#1.0.0', groups_allow: Iterable[str] | None = None, groups_deny: Iterable[str] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a POSIX Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • groups_allow (iterable of str, optional) – List of POSIX group IDs allowed to access this Storage Gateway. Private.

  • groups_deny (iterable of str, optional) – List of POSIX group IDs denied access this Storage Gateway. Private.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.S3StoragePolicies(DATA_TYPE: str = 's3_storage_policies#1.0.0', s3_endpoint: str | None = None, s3_buckets: Iterable[str] | None = None, s3_user_credential_required: bool | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: StorageGatewayPolicies

Convenience class for constructing a Google Cloud Storage Policy document to use as the policies parameter when creating a StorageGatewayDocument

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • s3_endpoint (str) – URL of the S3 API endpoint

  • s3_buckets (iterable of str) – List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this Storage Gateway.

  • s3_user_credential_required (str) – Flag indicating if a Globus User must register a user credential in order to create a Guest Collection on this Storage Gateway.

  • additional_fields (dict, optional) – Additional data for inclusion in the policy document

class globus_sdk.services.gcs.data.StorageGatewayDocument(DATA_TYPE: str | None = None, display_name: str | None = None, connector_id: UUID | str | None = None, root: str | None = None, identity_mappings: None | Iterable[dict[str, Any]] = None, policies: StorageGatewayPolicies | dict[str, Any] | None = None, allowed_domains: Iterable[str] | None = None, high_assurance: bool | None = None, require_mfa: bool | None = None, authentication_timeout_mins: int | None = None, users_allow: Iterable[str] | None = None, users_deny: Iterable[str] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: PayloadWrapper

Convenience class for constructing a Storage Gateway document to use as the data parameter to create_storage_gateway or update_storage_gateway

Parameters:

  • DATA_TYPE (str, optional) – Versioned document type. Defaults to the appropriate type for this class.

  • display_name (str, optional) – Name of the Storage Gateway

  • connector_id (str, optional) – UUID of the connector type that this Storage Gateway interacts with.

  • identity_mappings (iterable of dict, optional) – A list of IdentityMapping objects which are applied to user identities to attempt to determine what accounts are available for access.

  • policies (dict or StorageGatewayPolicy, optional) – Connector specific storage policies. It is recommended that you use one of the policy helper classes (e.g. POSIXStoragePolicies if you are using the POSIX connector) to create these.

  • allowed_domains (iterable of string) – List of allowed domains. Users creating credentials or collections on this Storage Gateway must have an identity in one of these domains.

  • restrict_paths (dict, optional) – Path restrictions within this Storage Gateway. Private.

  • high_assurance (bool, optional) – Flag indicating if the Storage Gateway requires high assurance features.

  • authentication_timeout_mins (int, optional) – Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

  • users_allow (iterable of str, optional) – List of connector-specific usernames allowed to access this Storage Gateway. Private.

  • users_deny (iterable of str, optional) – List of connector-specific usernames denied access to this Storage Gateway. Private.

  • process_user (str, optional) – Local POSIX user the GridFTP server should run as when accessing this Storage Gateway.

  • load_dsi_module (str, optional) – Name of the DSI module to load by the GridFTP server when accessing this Storage Gateway.

  • require_mfa (bool, optional) – Flag indicating that the Storage Gateway requires multi-factor authentication. Only usable on high assurance Storage Gateways.

  • additional_fields (dict, optional) – Additional data for inclusion in the Storage Gateway document

class globus_sdk.services.gcs.data.StorageGatewayPolicies(dict=None, /, **kwargs)[source]#

Bases: PayloadWrapper, ABC

This is the abstract base type for Storage Policies documents to use as the policies parameter when creating a StorageGatewayDocument.

Several fields on policy documents are marked as Private. This means that they are not visible except to admins and owners of the storage gateway.

class globus_sdk.services.gcs.data.UserCredentialDocument(DATA_TYPE: str = 'user_credential#1.0.0', identity_id: UUID | str | None = None, connector_id: UUID | str | None = None, username: str | None = None, display_name: str | None = None, storage_gateway_id: UUID | str | None = None, policies: dict[str, Any] | None = None, additional_fields: dict[str, Any] | None = None)[source]#

Bases: PayloadWrapper

Convenience class for constructing a UserCredential document to use as the data parameter to create_user_credential and update_user_credential

Parameters:

  • DATA_TYPE (str) – Versioned document type.

  • identity_id (UUID or str, optional) – UUID of the Globus identity this credential will provide access for

  • connector_id (UUID or str, optional) – UUID of the connector this credential is for

  • username (str, optional) – Username of the local account this credential will provide access to, format is connector specific

  • display_name (str, optional) – Display name for this credential

  • storage_gateway_id (UUID or str, optional) – UUID of the storage gateway this credential is for

  • policies (dict, optional) – Connector specific policies for this credential

  • additional_fields (dict, optional) – Additional data for inclusion in the document

Client Errors#

When an error occurs, a GCSClient will raise this specialized type of error, rather than a generic GlobusAPIError.

class globus_sdk.GCSAPIError(r: Response)[source]#

Bases: GlobusAPIError

Error class for the GCS Manager API client

GCS Responses#

class globus_sdk.services.gcs.response.IterableGCSResponse(response: Response | GlobusHTTPResponse, client: globus_sdk.BaseClient | None = None, *, iter_key: str | None = None)[source]#

Bases: IterableResponse

Response class for non-paged list oriented resources. Allows top level fields to be accessed normally via standard item access, and also provides a convenient way to iterate over the sub-item list in the data key:

>>> print("Path:", r["path"])
>>> # Equivalent to: for item in r["data"]
>>> for item in r:
>>>     print(item["name"], item["type"])
class globus_sdk.services.gcs.response.UnpackingGCSResponse(response: GlobusHTTPResponse, match: str | Callable[[dict[str, Any]], bool])[source]#

Bases: GlobusHTTPResponse

An “unpacking” response looks for a “data” array in the response data, which is expected to have dict elements. The “data” is traversed until the first matching object is found, and this is presented as the data property of the response.

The full response data is available as full_data.

If the expected datatype is not found in the array, or the array is missing, the data will be the full response data (identical to full_data).

Parameters:

match (str or callable) – Either a string containing a DATA_TYPE prefix, or an arbitrary callable which does the matching

property full_data: Any#

The full, parsed JSON response data. None if the data cannot be parsed as JSON.