Collections

Description

Type of this document

List of object IDs to operate on

Maximum page size for a paginated response

Pagination marker for a paginated response

Document values to include

Filter to apply to the return set

Filter collections which were created using this storage_gateway_id

Filter collections which were created using this mapped_collection_id

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before ACLs are considered. Read-only on guest collections. (Added in API 1.15.0)

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before ACLs are considered. Read-only on guest collections. (Added in API 1.15.0)

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before ACLs are considered. Read-only on guest collections. (Added in API 1.15.0)

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Date on which this collection was created

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before ACLs are considered. Read-only on guest collections. (Added in API 1.15.0)

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

Date on which this collection was last accessed

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Globus Auth Identity id

Document values to include

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before ACLs are considered. Read-only on guest collections. (Added in API 1.15.0)

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.

Flag indicating if guest collections on this mapped collection an allow anonymous write ACLs or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

Custom domain description

DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to True on a guest collection if the value on the related mapped collection is False.

Flag indicating whether all data transfers to and from this collection are always encrypted.

New in v5.4.17: If a mapped collection forces encryption, all of its guest collections must as well. If this option is used on a mapped collection, the value is propagated to its guest collections.

Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before ACLs are considered. Read-only on guest collections. (Added in API 1.15.0)

Flag indicating if this collection is created on a high assurance Storage Gateway.

HTTPS URL for the data on this collection.

Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

Link to a web page with more information about the collection

List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

URL of the GCS Manager API service for the endpoint hosting this collection.

Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

Connector-specific collection policies

Flag indicating whether this collection is visible to other Globus users.

Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on. [Private]

Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root. [Private]

List of connector-specific usernames allowed to create new guest collections on this mapped collection. [Private]

List of connector-specific usernames denied access to create new guest collections on this mapped collection. [Private]

Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

TLSFTP URL for the data on this collection.

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.

A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

Description

Type of this document

Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. 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 relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

Support for ~ was added in API version 1.21.0. [Private]

Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

Id of the connector type that is used by this collection.

Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

If the collection is mapped collection with a collection_base_path value of /, this value can also begin with the values /~/ and $HOME, which are replaced by the user’s home directory, or / if the connector does not support the concept of a home directory. [Private]

If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

Flag indicating that this collection has been deleted[Private]

Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

A description of the collection.