Type alias Admin

Admin: {
    addAutoIdStaticUserMapping(): Promise<void>;
    createLongLivedToken(clientId: string, clientSecret: string, scope: string, secret: string | boolean, lifetime: number): Promise<any>;
    createOAuth2ClientWithAdminPrivileges(clientId: string, clientSecret: string): Promise<void>;
    executeRfc7523AuthZGrantFlow(clientId: string, iss: string, jwk: JwkRsa, sub: string, scope?: string[]): Promise<AccessTokenResponseType>;
    generateRfc7523AuthZGrantArtefacts(clientId: string, iss: string, jwk?: JwkRsa, sub?: string, scope?: string[], options?: {
        save: boolean;
    }): Promise<{
        client: OAuth2ClientSkeleton;
        issuer: OAuth2TrustedJwtIssuerSkeleton;
        jwk: JwkRsa;
        jwks: JwksInterface;
    }>;
    generateRfc7523ClientAuthNArtefacts(clientId: string, aud?: string, jwk?: JwkRsa, options?: {
        save: boolean;
    }): Promise<{
        client: OAuth2ClientSkeleton;
        jwk: JwkRsa;
        jwks: JwksInterface;
        jwt: any;
    }>;
    grantOAuth2ClientAdminPrivileges(clientId: string): Promise<void>;
    hideGenericExtensionAttributes(includeCustomized: boolean, dryRun: boolean): Promise<void>;
    listNonOAuth2AdminStaticUserMappings(showProtected: boolean): Promise<string[]>;
    listOAuth2AdminClients(): Promise<string[]>;
    listOAuth2CustomClients(): Promise<string[]>;
    removeStaticUserMapping(subject: string): Promise<void>;
    repairOrgModel(excludeCustomized: boolean, extendPermissions: boolean, dryRun: boolean): Promise<void>;
    revokeOAuth2ClientAdminPrivileges(clientId: string): Promise<void>;
    showGenericExtensionAttributes(includeCustomized: boolean, dryRun: boolean): Promise<void>;
    trainAA(apiKey: string, apiSecret: string, customUsernames?: string[], customUserAgents?: string[], customIPs?: string[], loginsPerUser?: number, service?: string): Promise<void>;
}

Type declaration

  • addAutoIdStaticUserMapping:function
    • addAutoIdStaticUserMapping(): Promise<void>

    • Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • createLongLivedToken:function
    • createLongLivedToken(clientId: string, clientSecret: string, scope: string, secret: string | boolean, lifetime: number): Promise<any>

    • Parameters

      • clientId: string
      • clientSecret: string
      • scope: string
      • secret: string | boolean
      • lifetime: number

      Returns Promise<any>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • createOAuth2ClientWithAdminPrivileges:function
    • createOAuth2ClientWithAdminPrivileges(clientId: string, clientSecret: string): Promise<void>

    • Parameters

      • clientId: string
      • clientSecret: string

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • executeRfc7523AuthZGrantFlow:function
  • generateRfc7523AuthZGrantArtefacts:function
  • generateRfc7523ClientAuthNArtefacts:function
  • grantOAuth2ClientAdminPrivileges:function
    • grantOAuth2ClientAdminPrivileges(clientId: string): Promise<void>

    • Parameters

      • clientId: string

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • hideGenericExtensionAttributes:function
    • hideGenericExtensionAttributes(includeCustomized: boolean, dryRun: boolean): Promise<void>

    • Parameters

      • includeCustomized: boolean
      • dryRun: boolean

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • listNonOAuth2AdminStaticUserMappings:function
    • listNonOAuth2AdminStaticUserMappings(showProtected: boolean): Promise<string[]>

    • Parameters

      • showProtected: boolean

      Returns Promise<string[]>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • listOAuth2AdminClients:function
    • listOAuth2AdminClients(): Promise<string[]>

    • Returns Promise<string[]>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • listOAuth2CustomClients:function
    • listOAuth2CustomClients(): Promise<string[]>

    • Returns Promise<string[]>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • removeStaticUserMapping:function
    • removeStaticUserMapping(subject: string): Promise<void>

    • Parameters

      • subject: string

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • repairOrgModel:function
    • repairOrgModel(excludeCustomized: boolean, extendPermissions: boolean, dryRun: boolean): Promise<void>

    • Parameters

      • excludeCustomized: boolean
      • extendPermissions: boolean
      • dryRun: boolean

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • revokeOAuth2ClientAdminPrivileges:function
    • revokeOAuth2ClientAdminPrivileges(clientId: string): Promise<void>

    • Parameters

      • clientId: string

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • showGenericExtensionAttributes:function
    • showGenericExtensionAttributes(includeCustomized: boolean, dryRun: boolean): Promise<void>

    • Parameters

      • includeCustomized: boolean
      • dryRun: boolean

      Returns Promise<void>

      Deprecated

      Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

  • trainAA:function
    • trainAA(apiKey: string, apiSecret: string, customUsernames?: string[], customUserAgents?: string[], customIPs?: string[], loginsPerUser?: number, service?: string): Promise<void>

    • Parameters

      • apiKey: string
      • apiSecret: string
      • Optional customUsernames: string[]
      • Optional customUserAgents: string[]
      • Optional customIPs: string[]
      • Optional loginsPerUser: number
      • Optional service: string

      Returns Promise<void>

Settings

Member Visibility

Theme