openapi: 3.2.0
info:
description: The RBAC Management API. This is used to create and revoke grants on roles inside a database.
title: RBAC RBAC API API
contact: {}
version: 0.1.0
servers:
- url: https://api.live.altr.com/v1/rbac
tags:
- name: RBAC API
paths:
/databricks:
get:
security:
- BasicAuth: []
description: Get all the details on ALTR managed privileges for your organization. Treat combining filters as an `AND` operation.
tags:
- RBAC API
summary: List ALTR managed privileges for your organization.
parameters:
- description: The maximum number of items to return.
name: limit
in: query
schema:
type: integer
default: 50
maximum: 50
minimum: 1
- description: The number of items to skip.
name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
- description: Filter down to a specific principal.
name: principalName
in: query
schema:
type: string
- description: Filter down to a specific catalog.
name: catalogName
in: query
schema:
type: string
- description: Filter down to a specific schema. Requires `catalogName` to be specified.
name: schemaName
in: query
schema:
type: string
- description: Filter down to a specific table. Requires `catalogName` and `schemaName` to be specified.
name: tableName
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/types.ListDatabricksPrivilegesResponse'
'400':
description: Something about your request isn't correct. - Error codes 700000,700023,700024,700026,700027
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 600000
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
put:
security:
- BasicAuth: []
description: Batch create/update a role's privileges.
tags:
- RBAC API
summary: Batch create/update a role's privileges.
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/types.DatabricksPutBatchPrivilegeResponse'
'400':
description: Something about your request isn't correct. - Error codes 700000,700001,700004
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Specified database ID does not exist. - Error code 600001
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/types.DatabricksPutBatchPrivilegeRequest'
description: The batch of privileges to grant to the specified role.
required: true
patch:
security:
- BasicAuth: []
description: Add or Remove references attached to a databricks privilege. Used for tracking what is responsible for this grant. When all references are removed, the privilege can be revoked.
tags:
- RBAC API
summary: Add or Remove references attached to a databricks privilege.
responses:
'204':
description: The references have been updated.
'400':
description: Something about your request isn't correct. - Error code 700000,700033
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not Found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PatchDatabricksPrivilegeReferencesInput'
description: Add or Remove references from a databricks privilege.
required: true
/databricks/database-id/{databaseId}/principal-name/{principalName}/privilege/{privilege}/catalog-name/{catalogName}:
get:
security:
- BasicAuth: []
description: Get the details of an ALTR managed catalog privilege which is granted to a specified principal.
tags:
- RBAC API
summary: Get the details of an ALTR managed catalog privilege which is granted to a specified principal.
parameters:
- description: The ALTR Database ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The principal name that the privilege is granted to.
name: principalName
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The catalog name.
name: catalogName
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/rbac.DatabricksPrivilegeItem'
'400':
description: Something about your request isn't correct. - Error code 700006
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
delete:
security:
- BasicAuth: []
description: Delete/revoke an ALTR managed catalog privilege which is granted to a specified principal.
tags:
- RBAC API
summary: Delete/revoke an ALTR managed catalog privilege which is granted to a specified principal.
parameters:
- description: The ALTR Database ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The principal name that the privilege is granted to.
name: principalName
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The catalog name.
name: catalogName
in: path
required: true
schema:
type: string
- description: Whether to ignore errors during revocation.
name: x-altr-ignore-errors
in: header
schema:
type: boolean
- description: Revoke this privilege and this specified reference.
name: x-altr-reference
in: header
schema:
type: string
responses:
'202':
description: Privilege revocation is in progress if it exists.
'400':
description: Something about your request isn't correct. - Error codes 700000,700002,700006,700007,700008,700011,700012,700013,700014,700017,700030,700033
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
? /databricks/database-id/{databaseId}/principal-name/{principalName}/privilege/{privilege}/catalog-name/{catalogName}/schema-name/{schemaName}
: get:
security:
- BasicAuth: []
description: Get the details of an ALTR managed schema privilege which is granted to a specified principal.
tags:
- RBAC API
summary: Get the details of an ALTR managed schema privilege which is granted to a specified principal.
parameters:
- description: The ALTR Database ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The principal name that the privilege is granted to.
name: principalName
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The catalog name.
name: catalogName
in: path
required: true
schema:
type: string
- description: The schema name.
name: schemaName
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/rbac.DatabricksPrivilegeItem'
'400':
description: Something about your request isn't correct. - Error codes 700000,700002,700006,700007,700008,700011,700012,700013,700014,700017,700018,700019,700020,700022
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
delete:
security:
- BasicAuth: []
description: Delete/revoke an ALTR managed schema privilege which is granted to a specified principal.
tags:
- RBAC API
summary: Delete/revoke an ALTR managed schema privilege which is granted to a specified principal.
parameters:
- description: The ALTR Database ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The principal name that the privilege is granted to.
name: principalName
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The catalog name.
name: catalogName
in: path
required: true
schema:
type: string
- description: The schema name.
name: schemaName
in: path
required: true
schema:
type: string
- description: Whether to ignore errors during revocation.
name: x-altr-ignore-errors
in: header
schema:
type: boolean
- description: Revoke this privilege and this specified reference.
name: x-altr-reference
in: header
schema:
type: string
responses:
'202':
description: Privilege revocation is in progress if it exists.
'400':
description: Something about your request isn't correct. - Error codes 700000,700002,700006,700007,700008,700011,700012,700013,700014,700017,700019,700020,700030,700033
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
? /databricks/database-id/{databaseId}/principal-name/{principalName}/privilege/{privilege}/catalog-name/{catalogName}/schema-name/{schemaName}/table-name/{tableName}
: get:
security:
- BasicAuth: []
description: Get the details of an ALTR managed table privilege which is granted to a specified principal.
tags:
- RBAC API
summary: Get the details of an ALTR managed table privilege which is granted to a specified principal.
parameters:
- description: The ALTR Database ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The principal name that the privilege is granted to.
name: principalName
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The catalog name.
name: catalogName
in: path
required: true
schema:
type: string
- description: The schema name.
name: schemaName
in: path
required: true
schema:
type: string
- description: The table name.
name: tableName
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/rbac.DatabricksPrivilegeItem'
'400':
description: Something about your request isn't correct. - Error codes 700000,700002,700006,700007,700008,700011,700012,700013,700014,700017,700018,700019,700020,700021,700022
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
delete:
security:
- BasicAuth: []
description: Delete/revoke an ALTR managed table privilege which is granted to a specified principal.
tags:
- RBAC API
summary: Delete/revoke an ALTR managed table privilege which is granted to a specified principal.
parameters:
- description: The ALTR Database ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The principal name that the privilege is granted to.
name: principalName
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The catalog name.
name: catalogName
in: path
required: true
schema:
type: string
- description: The schema name.
name: schemaName
in: path
required: true
schema:
type: string
- description: The table name.
name: tableName
in: path
required: true
schema:
type: string
- description: Whether to ignore errors during revocation.
name: x-altr-ignore-errors
in: header
schema:
type: boolean
- description: Revoke this privilege and this specified reference.
name: x-altr-reference
in: header
schema:
type: string
responses:
'202':
description: Privilege revocation is in progress if it exists.
'400':
description: Something about your request isn't correct. - Error codes 700000,700002,700006,700007,700008,700011,700012,700013,700014,700017,700019,700020,700021,700022,700030,700033
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error codes 600000,600006,600007
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
/databricks/reference/{reference}:
get:
security:
- BasicAuth: []
description: List privileges by a given reference.
tags:
- RBAC API
summary: List privileges by a given reference.
parameters:
- description: The maximum number of items to return.
name: limit
in: query
schema:
type: integer
default: 50
maximum: 50
minimum: 1
- description: Unique pagination token for each page of results.
name: nextToken
in: query
schema:
type: string
- description: Filter privileges which are related to this given reference.
name: reference
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/management.ListDatabricksPrivilegesByReferenceOutput'
'400':
description: Something about your request isn't correct. - Error codes 700000,700003,700023,700024,700025
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 600000
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
/snowflake:
get:
security:
- BasicAuth: []
description: Get all the details on ALTR managed privileges for your organization. Treat combining filters as an `AND` operation.
tags:
- RBAC API
summary: List ALTR managed privileges for your organization.
parameters:
- description: The maximum number of items to return.
name: limit
in: query
schema:
type: integer
default: 50
maximum: 50
minimum: 1
- description: The number of items to skip.
name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
- description: Filter down to a specific role.
name: role
in: query
schema:
type: string
- description: Filter down to a specific database.
name: databaseName
in: query
schema:
type: string
- description: Filter down to a specific schema. Requires `databaseName` to be specified.
name: schemaName
in: query
schema:
type: string
- description: Filter down to a specific table. Requires `databaseName` and `schemaName` to be specified.
name: tableName
in: query
schema:
type: string
- description: Filter down to a specific view. Requires `databaseName` and `schemaName` to be specified.
name: viewName
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/management.ListSnowflakePrivilegesOutput'
'400':
description: Something about your request isn't correct. - Error codes 700000,700023,700024,700026,700027
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 60000
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
put:
security:
- BasicAuth: []
description: Batch create/update a role's privileges.
tags:
- RBAC API
summary: Batch create/update a role's privileges.
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/types.PutBatchSnowflakePrivilegesOutput'
'400':
description: Something about your request isn't correct. - Error codes 700000,700001,700004
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Specified database ID does not exist. - Error code 600001
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 600000
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PutBatchSnowflakePrivilegesInput'
description: The batch of privileges to grant to the specified role.
required: true
patch:
security:
- BasicAuth: []
description: Add or Remove references attached to a snowflake privilege. Used for tracking what is responsible for this grant. When all references are removed, the privilege can be revoked.
tags:
- RBAC API
summary: Add or Remove references attached to a snowflake privilege.
responses:
'204':
description: The references have been updated.
'400':
description: Something about your request isn't correct - Error code 700000,700033
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error code 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 600000
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PatchSnowflakePrivilegeReferencesInput'
description: Add or Remove references attached to a snowflake privilege.
required: true
/snowflake/database-id/{databaseId}/role-name/{role}/privilege/{privilege}/database-name/{databaseName}:
get:
security:
- BasicAuth: []
description: Get all the details on an ALTR managed privilege granted to a specified role.
tags:
- RBAC API
summary: Get an ALTR managed database privilege granted to a specified role.
parameters:
- description: The ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The role name that the privilege is granted to.
name: role
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The database name.
name: databaseName
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/management.GetSnowflakePrivilegeOutput'
'400':
description: Something about your request isn't correct. - Error codes 700000,700002,700006,700007,700008,700009,700010,700013,700014,700015,700016
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'401':
description: Not authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'404':
description: Not found. - Error codes 600001,600005
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
'500':
description: Internal error. Please try again and contact support if it persists. - Error code 600000
content:
application/json:
schema:
$ref: '#/components/schemas/types.RBACAPIErrorResponse'
delete:
security:
- BasicAuth: []
description: Delete/revoke an ALTR managed database privilege which is granted to a specified role.
tags:
- RBAC API
summary: Delete/revoke an ALTR managed database privilege which is granted to a specified role.
parameters:
- description: The ID of a connected database.
name: databaseId
in: path
required: true
schema:
type: integer
format: int64
maximum: 9223372036854775000
minimum: 1
- description: The role name that the privilege is granted to.
name: role
in: path
required: true
schema:
type: string
- description: The privilege granted to the specified role.
name: privilege
in: path
required: true
schema:
type: string
- description: The database name.
name: databaseName
in: path
required: true
schema:
type: string
- description: Whether to ignore errors during revocation.
name: x-altr-ignore-errors
in: header
schema:
type: boolean
- description: Revoke this privilege and this specified reference.
name: x-altr-reference
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altr/refs/heads/main/openapi/altr-rbac-api-api-openapi.yml