Databricks SDK for JavaScript
    Preparing search index...
    interface CreateRoleRequest {
        parent?: string;
        replaceExisting?: boolean;
        role?: Role;
        roleId?: string;
    }
    Index

    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. This requires role_id to be set. Without role_id, the request follows the normal create path and fails if the role name already exists.

    When the role already exists, only mutable fields are updated. Attributes omitted from the request retain their current values. Set an attribute explicitly to false to disable it. identity_type, auth_method, and postgres_role retain their existing values. Omit these fields or supply their current values. A differing supplied value returns INVALID_PARAMETER_VALUE and rejects the entire request, including changes to mutable fields. 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.