Schemas

Description

Unused

Globus Auth identity id that this credential is associated with

Mapped account username on the storage gateway

URL to redirect to once the credential registration flow is complete. This should be a maximum of 220 characters to avoid conflicts with connector state limits.

Storage gateway to associate the credential with

Description

Type of this document

Globus Auth identity which maps to this account

Storage Gateway for which this account is valid.

Connector-specific local username

Description

Type of this document

List of object IDs to operate on

Description

Type of this document

Boolean flag indicating whether the new authentication must be done within the same auth session as the application making the request.

List of identities that would have otherwise been authorized except that the authentication has timed out.

Description

Type of this document

Boolean flag indicating whether the new authentication must be done within the same auth session as the application making the request.

List of identities that would have otherwise been authorized except that the authentication has timed out.

Flag indicating that multi-factor authentication is required. Only occurs on high assurance storage gateways.

Description

Type of this document

Error details

ID of the object that was checked

Message describing the error

Description

Type of this document

PEM-Encoded X.509 certificate for this domain

PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate. [Private]

Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node. [Private]

Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node. [Private]

Domain name

PEM-Encoded private key for the certificate[Private]

Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node. [Private]

Flag indicating whether this is a wildcard domain or not.

When setting a custom domain for a mapped collection, the domain may optionally be a wildcard domain. If it is a wildcard domain, the guest collections will be created as subdomains of the mapped collection domain; if not, guest collections will be created as subdomains of the endpoint domain.

Description

Type of this document

Id of the mapped collection which this policy is associated with

Unique id for this sharing policy

Restrictions on which paths may be shared in guest collections related to this mapped collection. These paths are relative to the root_path property of the mapped collection.

List of local user accounts that this policy applies to. If omitted or null, this restriction applies to all local user accounts.

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).

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-.

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]

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.

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).

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]

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).

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 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 allow anonymous write permissions 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 allow anonymous write permissions 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 permissions 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 allow anonymous write permissions 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 permissions 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 allow anonymous write permissions 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 permissions 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 allow anonymous write permissions 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 permissions 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

Length of time that guest collection permissions are valid. Only settable on HA mapped collections and used by the guest collections attached to it. Set to null to delete any previously set value.

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 allow anonymous write permissions 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 permissions 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

Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lessor value is in effect. Set to null to delete any previously set value.

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 allow anonymous write permissions 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 permissions 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

Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lessor value is in effect. Set to null to delete any previously set value.

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 allow anonymous write permissions 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 permissions 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.

Flag indicating whether all data transfers to and from this collection require the remote collection be HA. This can only be assigned on high assurance mapped collections. High assurance guest collections inherit the restriction from their associated mapped collectans. This may be set to null to disable this feature.

If a restriction is in place for a collection, then HTTPS access to it is disabled.

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

collection ID

Description

Type of this document

Auth identity ID of the collection owner

Description

Type of this document

Friendly name of the connector

Unique id of this connector type

Semantic version of this connector implementation

Description

Type of this document

Friendly name of the connector

Unique id of this connector type

Subscription for this connector supports a BAA

Subscription for this connector supports high assurance

Semantic version of this connector implementation

Description

Type of this document

List of available accounts that do not have credentials registered.

Description

Type of this document

Allow data transfer on this endpoint using the UDT protocol

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

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

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

A description of the endpoint

Friendly name for the endpoint, not unique. Unicode string, no new lines (\r or \n). Searchable.

Unique identifier for this endpoint

URL of the GCS Manager API service for this endpoint

Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it is accepting public connections.

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

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

Control how Globus interacts with this endpoint over the network.

Allowed values for network_use are:

Organization that runs the server(s) represented by the endpoint. Unicode string, max 1024 characters, no new lines.

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

Admin-specified value when the network_use property’s value is custom; otherwise the preset value for the specified network_use.

Flag indicating whether this endpoint is visible to all other Globus users. If false, only users which have been granted a role on the endpoint or one of its collections, or belong to a domain allowed access to any of its storage gateways may view it.

The id of the subscription that is managing this endpoint. This may be the special value DEFAULT when using this as input to PATCH or PUT to use the caller’s default subscription id.

Description

Type of this document

Allow data transfer on this endpoint using the UDT protocol