Databricks SDK for JavaScript
    Preparing search index...

    Interface PrincipalOutput

    Information about the principal assigned to the workspace.

    interface PrincipalOutput {
        displayName?: string;
        principalId?: bigint;
        principalName?:
            | { $case: "userName"; userName: string }
            | { $case: "groupName"; groupName: string }
            | { $case: "servicePrincipalName"; servicePrincipalName: string };
    }
    Index

    Properties

    displayName? principalId? principalName?

    Properties

    displayName?: string

    The display name of the principal.

    principalId?: bigint

    The unique, opaque id of the principal.

    principalName?:
        | { $case: "userName"; userName: string }
        | { $case: "groupName"; groupName: string }
        | { $case: "servicePrincipalName"; servicePrincipalName: string }

    Type Declaration

    • { $case: "userName"; userName: string }
      • $case: "userName"
      • userName: string

        The username of the user. Present only if the principal is a user.

    • { $case: "groupName"; groupName: string }
      • $case: "groupName"
      • groupName: string

        The group name of the group. Present only if the principal is a group.

    • { $case: "servicePrincipalName"; servicePrincipalName: string }
      • $case: "servicePrincipalName"
      • servicePrincipalName: string

        The name of the service principal. Present only if the principal is a service principal.

    Settings

    Member Visibility

    On This Page

    Properties