grant_resource_access

ResourceAccessApi.grant_resource_access(resource, role_id, resource_access_grant_input, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Grant resource access to users or tags

Grants owner, editor, or read-only access. Max 20 ResourceIds and 20 AccessTags. Caller must have sufficient access on each resource. Single-resource grants return “{Resource} access updated successfully”; otherwise the update runs in the background.

Parameters:

  • resource (str) – Resource type (datasets, dashboards, domains, tags, etc.) (required)

  • role_id (str) – Amorphic role ID used for authorization (required)

  • resource_access_grant_input (ResourceAccessGrantInput) – (required)

  • content_type (str) – Request content type (application/json)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

Message

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /share/{resource}

Request

Request / response example

{
  "ResourceIds": [
    "11111111-1111-1111-1111-111111111111"
  ],
  "AccessTags": [
    {
      "TagKey": "user",
      "TagValue": "colleague@example.com"
    }
  ],
  "AccessType": "editor"
}

Success (HTTP 200)

Access granted or update triggered in background

Errors

HTTP 400

Invalid input or not authorized

Request / response example

{
  "Message": "Invalid access type owner for chat resource. Only read-only access can be granted."
}

HTTP 500

Something went wrong at backend