Role Existence

Early Access: This API is provided in Early Access. Please contact our customer support team for more information and to enable this feature.

Overview

The Role Existence API allows users to check whether a role with specific resource permissions already exists in the system. This API is particularly useful for role management and access governance in Snowflake environments.

Use cases and features

This API enables efficient role management by identifying existing roles that already have the permissions you're looking for. Key use cases include:

1. Role Discovery: Find existing roles that match specific permission requirements

2. Prevent Role Proliferation: Avoid creating duplicate roles with the same permissions

3. Permission Auditing: Verify which roles have specific permissions to resources

Limitations

• This feature is currently limited to the .

Role Existence API

Request Parameters

The API accepts a request object with the following parameters:

ResourcePermissions Structure

Each ResourcePermissions object contains:

Protocol Definition

Proto Message Definitions

The API uses the following protocol buffer message definitions:

Response Structure

The API returns a response object with the following field:

Usage Example

Request

This example checks if there's an existing role with USAGE permission on a specific Snowflake database:

Response

The response indicates that a matching role exists:

Example: Multiple Resource Permissions

You can check for roles that have permissions across multiple resources:

Request

Response

Example: No Matching Roles

In this example, the request is checking for roles with specific permissions, but no matching roles are found:

Request

Response

The response indicates that no matching roles with the specified permission combination exist:

When you receive an empty response like this, it suggests that a new role might need to be created to satisfy these specific permission requirements, as no existing role has the exact permission set requested.

Related APIs