> ## Documentation Index > Fetch the complete documentation index at: https://docs.textql.com/llms.txt > Use this file to discover all available pages before exploring further. # Assign Permission To Role ## OpenAPI ````yaml api-reference/speakeasy/textql-api-with-code-samples.yaml POST /textql.rpc.public.rbac.RBACService/AssignPermissionToRole openapi: 3.1.0 info: title: TextQL API version: 1.0.0 description: | TextQL public API. Generated from protobuf service definitions; internal endpoints are excluded via google.api.visibility / file_visibility. servers: - url: https://app.textql.com/rpc/public security: - apiKey: [] tags: - name: DashboardService - name: AppService description: |- AppService manages data apps: the generative app execution primitive. An app is agent-authored single-file HTML/JS/CSS executing in a CSP sandbox, fed a snapshot of its declared data sources. First-class resource, not a dashboard. - name: ConnectorService - name: PowerBIService - name: TableauService - name: DatasetService - name: OntologyManagementService - name: ChatService - name: AgentService - name: SecretService - name: ApiOAuthService - name: AuditLogService - name: MCPService - name: MetricsExportService - name: ObservabilityService - name: PlaybookService - name: RBACService description: RBAC service for managing roles, permissions, and access control - name: SandboxAdminService - name: SandboxQueryService - name: SandboxCapabilityService - name: SandboxExecService - name: ScimService - name: SettingsService - name: SlackService - name: TeamsService paths: /textql.rpc.public.rbac.RBACService/AssignPermissionToRole: post: tags: - RBACService summary: AssignPermissionToRole operationId: RBACService_AssignPermissionToRole parameters: - name: Connect-Protocol-Version in: header required: true schema: $ref: '#/components/schemas/connect-protocol-version' - name: Connect-Timeout-Ms in: header schema: $ref: '#/components/schemas/connect-timeout-header' requestBody: content: application/json: schema: $ref: >- #/components/schemas/textql.rpc.public.rbac.AssignPermissionToRoleRequest required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/textql.rpc.public.rbac.AssignPermissionToRoleResponse default: description: Error content: application/json: schema: $ref: '#/components/schemas/connect.error' x-codeSamples: - lang: typescript label: TypeScript (SDK) source: |- import { Textql } from "@textql/sdk"; const textql = new Textql({ apiKey: process.env["TEXTQL_API_KEY"] ?? "", }); async function run() { const result = await textql.rbac.assignPermissionToRole({ body: {}, }); console.log(result); } run(); - lang: python label: Python (SDK) source: |- import os from textql_sdk import Textql with Textql( api_key=os.getenv("TEXTQL_API_KEY", ""), ) as textql: res = textql.rbac.assign_permission_to_role() # Handle response print(res) components: schemas: connect-protocol-version: type: number title: Connect-Protocol-Version enum: - 1 description: Define the version of the Connect protocol const: 1 default: 1 connect-timeout-header: type: number title: Connect-Timeout-Ms description: Define the timeout, in ms textql.rpc.public.rbac.AssignPermissionToRoleRequest: type: object properties: roleName: type: string title: role_name description: >- Exact, case-sensitive role name, unique within the caller's organization. Supply role_name or role_id. permission: $ref: '#/components/schemas/textql.rpc.public.rbac.PermissionSpec' title: permission roleId: type: string title: role_id description: >- Existing role ID. Prefer role_name; if both are supplied they must match. title: AssignPermissionToRoleRequest additionalProperties: false textql.rpc.public.rbac.AssignPermissionToRoleResponse: type: object properties: success: type: boolean title: success title: AssignPermissionToRoleResponse additionalProperties: false connect.error: type: object properties: code: type: string examples: - not_found enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated description: >- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. message: type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. details: type: array items: $ref: '#/components/schemas/connect.error_details.Any' description: >- A list of messages that carry the error details. There is no limit on the number of messages. title: Connect Error additionalProperties: true description: >- Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation textql.rpc.public.rbac.PermissionSpec: type: object oneOf: - type: object properties: agent: $ref: >- #/components/schemas/textql.rpc.public.rbac.AgentPermissionAction title: agent title: agent required: - agent - type: object properties: apiAccessKey: $ref: >- #/components/schemas/textql.rpc.public.rbac.ApiAccessKeyPermissionAction title: api_access_key title: api_access_key required: - apiAccessKey - type: object properties: auditLog: $ref: >- #/components/schemas/textql.rpc.public.rbac.AuditLogPermissionAction title: audit_log title: audit_log required: - auditLog - type: object properties: billing: $ref: >- #/components/schemas/textql.rpc.public.rbac.BillingPermissionAction title: billing title: billing required: - billing - type: object properties: chat: $ref: '#/components/schemas/textql.rpc.public.rbac.ChatPermissionAction' title: chat title: chat required: - chat - type: object properties: connector: $ref: >- #/components/schemas/textql.rpc.public.rbac.ConnectorPermissionAction title: connector title: connector required: - connector - type: object properties: context: $ref: >- #/components/schemas/textql.rpc.public.rbac.ContextPermissionAction title: context title: context required: - context - type: object properties: contextPolicy: $ref: >- #/components/schemas/textql.rpc.public.rbac.ContextPolicyPermissionAction title: context_policy title: context_policy required: - contextPolicy - type: object properties: dashboard: $ref: >- #/components/schemas/textql.rpc.public.rbac.DashboardPermissionAction title: dashboard title: dashboard required: - dashboard - type: object properties: dataset: $ref: >- #/components/schemas/textql.rpc.public.rbac.DatasetPermissionAction title: dataset title: dataset required: - dataset - type: object properties: designSystem: $ref: >- #/components/schemas/textql.rpc.public.rbac.DesignSystemPermissionAction title: design_system title: design_system required: - designSystem - type: object properties: feed: $ref: '#/components/schemas/textql.rpc.public.rbac.FeedPermissionAction' title: feed title: feed required: - feed - type: object properties: group: $ref: >- #/components/schemas/textql.rpc.public.rbac.GroupPermissionAction title: group title: group required: - group - type: object properties: mcp: $ref: '#/components/schemas/textql.rpc.public.rbac.McpPermissionAction' title: mcp title: mcp required: - mcp - type: object properties: member: $ref: >- #/components/schemas/textql.rpc.public.rbac.MemberPermissionAction title: member title: member required: - member - type: object properties: memory: $ref: >- #/components/schemas/textql.rpc.public.rbac.MemoryPermissionAction title: memory title: memory required: - memory - type: object properties: observability: $ref: >- #/components/schemas/textql.rpc.public.rbac.ObservabilityPermissionAction title: observability title: observability required: - observability - type: object properties: ontology: $ref: >- #/components/schemas/textql.rpc.public.rbac.OntologyPermissionAction title: ontology title: ontology required: - ontology - type: object properties: organization: $ref: >- #/components/schemas/textql.rpc.public.rbac.OrganizationPermissionAction title: organization title: organization required: - organization - type: object properties: packages: $ref: >- #/components/schemas/textql.rpc.public.rbac.PackagesPermissionAction title: packages title: packages required: - packages - type: object properties: pipeline: $ref: >- #/components/schemas/textql.rpc.public.rbac.PipelinePermissionAction title: pipeline title: pipeline required: - pipeline - type: object properties: playbook: $ref: >- #/components/schemas/textql.rpc.public.rbac.PlaybookPermissionAction title: playbook title: playbook required: - playbook - type: object properties: role: $ref: '#/components/schemas/textql.rpc.public.rbac.RolePermissionAction' title: role title: role required: - role - type: object properties: rolePermission: $ref: >- #/components/schemas/textql.rpc.public.rbac.RolePermissionPermissionAction title: role_permission title: role_permission required: - rolePermission - type: object properties: sandbox: $ref: >- #/components/schemas/textql.rpc.public.rbac.SandboxPermissionAction title: sandbox title: sandbox required: - sandbox - type: object properties: scim: $ref: '#/components/schemas/textql.rpc.public.rbac.ScimPermissionAction' title: scim title: scim required: - scim - type: object properties: secret: $ref: >- #/components/schemas/textql.rpc.public.rbac.SecretPermissionAction title: secret title: secret required: - secret - type: object properties: usage: $ref: >- #/components/schemas/textql.rpc.public.rbac.UsagePermissionAction title: usage title: usage required: - usage title: PermissionSpec additionalProperties: false description: >- A single RBAC permission. Select a resource and one of its supported actions. connect.error_details.Any: type: object properties: type: type: string description: >- A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field. value: type: string format: binary description: >- The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field. debug: oneOf: - type: object title: Any additionalProperties: true description: Detailed error information. discriminator: propertyName: type title: Debug description: >- Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic. additionalProperties: true description: >- Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details. textql.rpc.public.rbac.AgentPermissionAction: type: string title: AgentPermissionAction enum: - AGENT_ACTION_UNSPECIFIED - AGENT_ACTION_READ - AGENT_ACTION_READ_PRIVATE - AGENT_ACTION_WRITE - AGENT_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.ApiAccessKeyPermissionAction: type: string title: ApiAccessKeyPermissionAction enum: - API_ACCESS_KEY_ACTION_UNSPECIFIED - API_ACCESS_KEY_ACTION_DELEGATE - API_ACCESS_KEY_ACTION_READ - API_ACCESS_KEY_ACTION_READ_PRIVATE - API_ACCESS_KEY_ACTION_WRITE - API_ACCESS_KEY_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.AuditLogPermissionAction: type: string title: AuditLogPermissionAction enum: - AUDIT_LOG_ACTION_UNSPECIFIED - AUDIT_LOG_ACTION_READ textql.rpc.public.rbac.BillingPermissionAction: type: string title: BillingPermissionAction enum: - BILLING_ACTION_UNSPECIFIED - BILLING_ACTION_READ textql.rpc.public.rbac.ChatPermissionAction: type: string title: ChatPermissionAction enum: - CHAT_ACTION_UNSPECIFIED - CHAT_ACTION_READ - CHAT_ACTION_READ_PRIVATE - CHAT_ACTION_WRITE - CHAT_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.ConnectorPermissionAction: type: string title: ConnectorPermissionAction enum: - CONNECTOR_ACTION_UNSPECIFIED - CONNECTOR_ACTION_RAW_SQL - CONNECTOR_ACTION_READ - CONNECTOR_ACTION_READ_PRIVATE - CONNECTOR_ACTION_WRITE - CONNECTOR_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.ContextPermissionAction: type: string title: ContextPermissionAction enum: - CONTEXT_ACTION_UNSPECIFIED - CONTEXT_ACTION_READ - CONTEXT_ACTION_READ_PRIVATE - CONTEXT_ACTION_WRITE - CONTEXT_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.ContextPolicyPermissionAction: type: string title: ContextPolicyPermissionAction enum: - CONTEXT_POLICY_ACTION_UNSPECIFIED - CONTEXT_POLICY_ACTION_READ - CONTEXT_POLICY_ACTION_WRITE textql.rpc.public.rbac.DashboardPermissionAction: type: string title: DashboardPermissionAction enum: - DASHBOARD_ACTION_UNSPECIFIED - DASHBOARD_ACTION_READ - DASHBOARD_ACTION_READ_PRIVATE - DASHBOARD_ACTION_WRITE - DASHBOARD_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.DatasetPermissionAction: type: string title: DatasetPermissionAction enum: - DATASET_ACTION_UNSPECIFIED - DATASET_ACTION_READ - DATASET_ACTION_READ_PRIVATE - DATASET_ACTION_WRITE - DATASET_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.DesignSystemPermissionAction: type: string title: DesignSystemPermissionAction enum: - DESIGN_SYSTEM_ACTION_UNSPECIFIED - DESIGN_SYSTEM_ACTION_WRITE textql.rpc.public.rbac.FeedPermissionAction: type: string title: FeedPermissionAction enum: - FEED_ACTION_UNSPECIFIED - FEED_ACTION_READ - FEED_ACTION_READ_PRIVATE - FEED_ACTION_WRITE - FEED_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.GroupPermissionAction: type: string title: GroupPermissionAction enum: - GROUP_ACTION_UNSPECIFIED - GROUP_ACTION_READ - GROUP_ACTION_WRITE textql.rpc.public.rbac.McpPermissionAction: type: string title: McpPermissionAction enum: - MCP_ACTION_UNSPECIFIED - MCP_ACTION_READ - MCP_ACTION_WRITE textql.rpc.public.rbac.MemberPermissionAction: type: string title: MemberPermissionAction enum: - MEMBER_ACTION_UNSPECIFIED - MEMBER_ACTION_READ - MEMBER_ACTION_WRITE textql.rpc.public.rbac.MemoryPermissionAction: type: string title: MemoryPermissionAction enum: - MEMORY_ACTION_UNSPECIFIED - MEMORY_ACTION_WRITE textql.rpc.public.rbac.ObservabilityPermissionAction: type: string title: ObservabilityPermissionAction enum: - OBSERVABILITY_ACTION_UNSPECIFIED - OBSERVABILITY_ACTION_READ - OBSERVABILITY_ACTION_WRITE textql.rpc.public.rbac.OntologyPermissionAction: type: string title: OntologyPermissionAction enum: - ONTOLOGY_ACTION_UNSPECIFIED - ONTOLOGY_ACTION_READ - ONTOLOGY_ACTION_READ_PRIVATE - ONTOLOGY_ACTION_WRITE - ONTOLOGY_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.OrganizationPermissionAction: type: string title: OrganizationPermissionAction enum: - ORGANIZATION_ACTION_UNSPECIFIED - ORGANIZATION_ACTION_READ - ORGANIZATION_ACTION_WRITE textql.rpc.public.rbac.PackagesPermissionAction: type: string title: PackagesPermissionAction enum: - PACKAGES_ACTION_UNSPECIFIED - PACKAGES_ACTION_READ - PACKAGES_ACTION_WRITE textql.rpc.public.rbac.PipelinePermissionAction: type: string title: PipelinePermissionAction enum: - PIPELINE_ACTION_UNSPECIFIED - PIPELINE_ACTION_READ - PIPELINE_ACTION_RUN - PIPELINE_ACTION_WRITE textql.rpc.public.rbac.PlaybookPermissionAction: type: string title: PlaybookPermissionAction enum: - PLAYBOOK_ACTION_UNSPECIFIED - PLAYBOOK_ACTION_READ - PLAYBOOK_ACTION_READ_PRIVATE - PLAYBOOK_ACTION_WRITE - PLAYBOOK_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.RolePermissionAction: type: string title: RolePermissionAction enum: - ROLE_ACTION_UNSPECIFIED - ROLE_ACTION_READ - ROLE_ACTION_WRITE textql.rpc.public.rbac.RolePermissionPermissionAction: type: string title: RolePermissionPermissionAction enum: - ROLE_PERMISSION_ACTION_UNSPECIFIED - ROLE_PERMISSION_ACTION_READ - ROLE_PERMISSION_ACTION_WRITE textql.rpc.public.rbac.SandboxPermissionAction: type: string title: SandboxPermissionAction enum: - SANDBOX_ACTION_UNSPECIFIED - SANDBOX_ACTION_READ - SANDBOX_ACTION_READ_PRIVATE - SANDBOX_ACTION_WRITE - SANDBOX_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.ScimPermissionAction: type: string title: ScimPermissionAction enum: - SCIM_ACTION_UNSPECIFIED - SCIM_ACTION_READ - SCIM_ACTION_WRITE textql.rpc.public.rbac.SecretPermissionAction: type: string title: SecretPermissionAction enum: - SECRET_ACTION_UNSPECIFIED - SECRET_ACTION_READ - SECRET_ACTION_READ_PRIVATE - SECRET_ACTION_WRITE - SECRET_ACTION_WRITE_PRIVATE textql.rpc.public.rbac.UsagePermissionAction: type: string title: UsagePermissionAction enum: - USAGE_ACTION_UNSPECIFIED - USAGE_ACTION_READ securitySchemes: apiKey: type: apiKey in: header name: tql_api_key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.