Skip to navigation
Sigma REST APIConnectionsconnection grants

Add grants to a connection

View as Markdown

Add grants to grant permissions on a connection to specific users or teams.

Usage notes

  • See Data permissions overview for details about permissions that can be granted on a connection.

  • Retrieve the connectionId by calling the /v2/connections endpoint.

  • Specify the team or user IDs to grant permissions:

    • Retrieve the memberId by calling the /v2/members endpoint.
    • Retrieve the teamId by calling the /v2/teams endpoint.

Usage scenarios

  • Grant a specific team Can use access to a connection.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

connectionIdstringRequired

Request

The request body.
grantslist of objectsRequired

Response

The response body.