Frodo Library - v5.0.0-17
    Preparing search index...

    Type Alias ServiceAccount

    type ServiceAccount = {
        createServiceAccount(
            name: string,
            description: string,
            accountStatus: "active" | "inactive",
            scopes: string[],
            jwks: JwksInterface,
        ): Promise<IdObjectSkeletonInterface>;
        getServiceAccount(serviceAccountId: string): Promise<ServiceAccountType>;
        isServiceAccountsFeatureAvailable(): Promise<boolean>;
        validateServiceAccount(
            saId?: string,
            saJwk?: JwkRsa,
        ): Promise<AccessTokenMetaType>;
    }
    Index
    createServiceAccount getServiceAccount isServiceAccountsFeatureAvailable validateServiceAccount

    • Create service account

      Parameters

      • name: string

        Human-readable name of service account

      • description: string

        Description of service account

      • accountStatus: "active" | "inactive"

        Service account status

      • scopes: string[]

        Scopes.

      • jwks: JwksInterface

        Java Web Key Set

      Returns Promise<IdObjectSkeletonInterface>

      A promise resolving to a service account object

    • Check if service accounts are available

      Returns Promise<boolean>

      true if service accounts are available, false otherwise

      since v5.0.0. The answer is not authoritative: it comes from the tenant's feature list, which the admin UI does not consult before it shows service accounts, and a failed read looks the same as a missing feature. Create the service account and handle the error instead; frodo-cli no longer calls this.

    Settings
    Member Visibility

    On This Page
    Methods