Databricks SDK for JavaScript
    Preparing search index...

    Interface CreateRoleRequest

    interface CreateRoleRequest {
        parent?: string;
        replaceExisting?: boolean;
        role?: Role;
        roleId?: string;
    }
    Index

    Properties

    parent? replaceExisting? role? roleId?

    Properties

    parent?: string

    The Branch where this Role is created. Format: projects/{project_id}/branches/{branch_id}

    replaceExisting?: boolean

    If true, update the role if it already exists instead of returning an error.

    When the role already exists, the provided role spec fully replaces the existing one: membership_roles is overwritten, not merged. Leaving membership_roles empty clears all of the role's existing memberships, including DATABRICKS_SUPERUSER. Always send the complete desired list of memberships when using this field.

    role?: Role

    The desired specification of a Role.

    roleId?: string

    The ID to use for the Role, which will become the final component of the role's resource name. This ID becomes the role in Postgres.

    This value should be 4-63 characters, and valid characters are lowercase letters, numbers, and hyphens, as defined by RFC 1123.

    If role_id is not specified in the request, it is generated automatically.

    Settings

    Member Visibility

    On This Page

    Properties