Transfer Action Provider: Create GCSv5 Guest Collection

URL: https://transfer.actions.globus.org/gcsv5/create_guest_collection

Synchronous / Asynchronous: Synchronous

The Create GCSv5 Guest Collection action provider uses the Globus Connect Server Manager API to create a guest collection on a Globus Connect Server v5 host.

Tip

The Globus Auth scope for this action provider is:

urn:globus:auth:scope:transfer.actions.globus.org:create_guest_collection

Note

Currently, only POSIX storage gateways are supported for this action.
The parent mapped collection (referenced by mapped_collection_id) must be associated with an active Globus subscription.

{
  "mapped_collection_id": "aabbccdd-eeff-2233-4455-aabbccddeeff",
  "collection_base_path": "/~/shared/",
  "display_name": "My Guest Collection"
}

{
  "action_id": "gFJDMXVOPf24",
  "completion_time": "2023-06-26 18:53:31.842557+00:00",
  "creator_id": "urn:globus:auth:identity:12341234-abcd-abcd-abcd-123412341234",
  "details": {
    "DATA_TYPE": "collection#1.9.0",
    "authentication_timeout_mins": 43200,
    "collection_type": "guest",
    "connector_id": "12341234-abcd-abcd-abcd-123412341234",
    "contact_email": null,
    "created_at": "2023-06-26",
    "disable_anonymous_writes": false,
    "disable_verify": false,
    "display_name": "guest collection 6-26",
    "domain_name": "abcd1234.data.globus.org",
    "enable_https": true,
    "force_encryption": false,
    "force_verify": false,
    "high_assurance": false,
    "https_url": "https://abcd1234.data.globus.org",
    "id": "12341234-abcd-abcd-abcd-123412341234",
    "identity_id": "12341234-abcd-abcd-abcd-123412341234",
    "last_access": null,
    "manager_url": "https://abcd1234.data.globus.org",
    "mapped_collection_id": "12341234-abcd-abcd-abcd-123412341234",
    "policies": {
      "DATA_TYPE": "posix_collection_policies#1.1.0"
    },
    "public": false,
    "require_mfa": false,
    "storage_gateway_id": "12341234-abcd-abcd-abcd-123412341234",
    "tlsftp_url": "tlsftp://abcd1234.data.globus.org:443",
    "user_credential_id": "12341234-abcd-abcd-abcd-123412341234"
  },
  "display_status": "SUCCEEDED",
  "label": null,
  "manage_by": [],
  "monitor_by": [],
  "release_after": null,
  "start_time": "2023-06-26 18:53:28.802298+00:00",
  "status": "SUCCEEDED"
}

{
  "__COMMENT": "The resulting guest collection id will be `$.create_guest_result.details.id`",
  "create_guest": {
    "Type": "Action",
    "ActionUrl": "https://transfer.actions.globus.org/gcsv5/create_guest_collection",
    "Parameters": {
      "public.$": "$.public",
      "display_name.$": "$.display_name",
      "collection_base_path.$": "$.path",
      "mapped_collection_id.$": "$.endpoint_id"
    },
    "ResultPath": "$.create_guest_result"
  }
}