Transfer API
  • Transfer API Documentation
  • API Overview
  • Task Submission
  • Task Events
  • Task Management
  • File Operations
  • Endpoints and Collections
  • Globus Connect Personal Management
  • Endpoint and Collection Search
  • Roles
  • Collection Bookmarks
  • Guest Collection Permission Management
  • Advanced Collection Management
  • Task Behavior
  • Transfer Action Providers
    • Migrating Transfer Action Providers
    • Transfer Action Provider: Transfer
    • Transfer Action Provider: Delete
    • Transfer Action Provider: Manage Permission
    • Transfer Action Provider: List Directory Contents
    • Transfer Action Provider: Stat File or Directory
    • Transfer Action Provider: Make Directory
    • Transfer Action Provider: Collection Info
    • Transfer Action Provider: Create GCP Guest Collection
    • Transfer Action Provider: Create GCSv5 Guest Collection
Skip to main content
Globus Docs
  • Getting Started
    Getting Started

    Getting Started and Tutorial docs cover how to perform some activity or provide an introduction to a feature. They are not comprehensive, but help you get started with Globus or with new Globus features.

    • Users
    • Admins
    • Developers
  • Reference
    Reference
    • Service
      • Auth
      • Groups
      • Transfer
      • Timers
      • Flows
      • Compute
      • Search
    • Agents
      • Globus Connect Server
      • GCS CLI
      • Globus Connect Personal
      • Globus Compute
    • SDK
      • Python
      • JS
    • Clients
      • CLI
    • Security and Compliance
      • Product Security
      • Privacy
      • Solutions for Sensitive Data
      • FAQs
  • Solutions & Guides
    Solutions & Guides

    Find practical approaches for leveraging Globus in research environments, integrating with platforms, and building science gateways. Access hands-on guides, integration instructions, and real-world scenarios for advanced usage.

    • Portals/Science Gateways
    • Guides
  • Support
    Support

    Find answers to frequently asked questions, connect with the community by joining our mailing lists, or reach out directly to Globus support.

    • FAQs
    • Mailing Lists
    • Contact Us
    • Check Support Tickets
  • Site Search
  1. Home
  2. Globus Services
  3. Transfer API Documentation
  4. Transfer Action Providers
  5. Transfer Action Provider: Manage Permission

Transfer Action Provider: Manage Permission

URL: https://transfer.actions.globus.org/manage_permission

Synchronous / Asynchronous: Synchronous

The Manage Permission action provider uses the Globus Transfer API’s permission resources to manage permissions on a directory. The body of the request indicates whether the permission rule is to be created, updated or deleted using the operation property.

For update or delete, the access rule_id of a previously created permission rule must be provided. This is the equivalent to the access_id field returned by a permission create operation.

{
  "operation": "CREATE",
  "endpoint_id": "6c54cade-bde5-45c1-bdea-f4bd71dba2cc",
  "path": "/~/shared/",
  "principal_type": "identity",
  "principal": "7c43a2b1-ac1e-4459-bde8-13ea2d33c878",
  "permissions": "r"
}
{
  "action_id": "NecVabcdefg",
  "completion_time": "2023-06-30 12:10:00.808680+00:00",
  "creator_id": "urn:globus:auth:identity:12341234-abcd-abcd-abcd-123412341234",
  "details": {
    "DATA_TYPE": "access_create_result",
    "access_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "code": "Created",
    "message": "Access rule created successfully.",
    "request_id": "RJ2CqHEfa",
    "resource": "/endpoint/6c54cade-bde5-45c1-bdea-f4bd71dba2cc/access"
  },
  "display_status": "SUCCEEDED",
  "label": null,
  "manage_by": [],
  "monitor_by": [],
  "release_after": "P30D",
  "start_time": "2023-06-30 12:09:59.358716+00:00",
  "status": "SUCCEEDED"
}
{
  "operation": "DELETE",
  "endpoint_id": "6c54cade-bde5-45c1-bdea-f4bd71dba2cc",
  "rule_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
{
  "action_id": "Cks9Rabcdef",
  "completion_time": "2023-06-30 12:27:14.986350+00:00",
  "creator_id": "urn:globus:auth:identity:ff544380-a7f1-4d88-9618-f0cfb4195218",
  "details": {
    "DATA_TYPE": "result",
    "code": "Deleted",
    "message": "Access rule 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' deleted successfully",
    "request_id": "yr1EzMQKX",
    "resource": "/endpoint/6c54cade-bde5-45c1-bdea-f4bd71dba2cc/access/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  },
  "display_status": "SUCCEEDED",
  "label": null,
  "manage_by": [],
  "monitor_by": [],
  "release_after": "P30D",
  "start_time": "2023-06-30 12:27:14.033917+00:00",
  "status": "SUCCEEDED"
}
{
  "operation": "UPDATE",
  "endpoint_id": "6c54cade-bde5-45c1-bdea-f4bd71dba2cc",
  "rule_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "permissions": "rw"
}
{
  "action_id": "dw9Tabcdef",
  "completion_time": "2023-06-30 12:25:04.827736+00:00",
  "creator_id": "urn:globus:auth:identity:12341234-abcd-abcd-abcd-123412341234",
  "details": {
    "DATA_TYPE": "result",
    "code": "Updated",
    "message": "Access rule 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' permissions updated successfully",
    "request_id": "6JL33c2Nh",
    "resource": "/endpoint/6c54cade-bde5-45c1-bdea-f4bd71dba2cc/access/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  },
  "display_status": "SUCCEEDED",
  "label": null,
  "manage_by": [],
  "monitor_by": [],
  "release_after": "P30D",
  "start_time": "2023-06-30 12:25:03.642568+00:00",
  "status": "SUCCEEDED"
}
{
  "__COMMENT": "The resulting permission id will be `$.create_permission_result.details.access_id`",
  "create_permission": {
    "Type": "Action",
    "ActionUrl": "https://transfer.actions.globus.org/manage_permission",
    "Parameters": {
      "operation": "CREATE",
      "endpoint_id.$": "$.endpoint_id",
      "principal_type.$": "$.principal_type",
      "principal.$": "$.principal",
      "path.$": "$.path",
      "permissions.$": "$.permissions"
    },
    "ResultPath": "$.create_permission_result"
  }
}
  • Transfer API Documentation
  • API Overview
  • Task Submission
  • Task Events
  • Task Management
  • File Operations
  • Endpoints and Collections
  • Globus Connect Personal Management
  • Endpoint and Collection Search
  • Roles
  • Collection Bookmarks
  • Guest Collection Permission Management
  • Advanced Collection Management
  • Task Behavior
  • Transfer Action Providers
    • Migrating Transfer Action Providers
    • Transfer Action Provider: Transfer
    • Transfer Action Provider: Delete
    • Transfer Action Provider: Manage Permission
    • Transfer Action Provider: List Directory Contents
    • Transfer Action Provider: Stat File or Directory
    • Transfer Action Provider: Make Directory
    • Transfer Action Provider: Collection Info
    • Transfer Action Provider: Create GCP Guest Collection
    • Transfer Action Provider: Create GCSv5 Guest Collection
© 2010- The University of Chicago Legal Privacy Accessibility