Class default

constructor

• new default(): default

  Returns default

Staticinit

StaticcreateOAuth2Client

• createOAuth2Client(
      input: Partial,
      userContext?: Record<string, any>,
  ): Promise<
      | { client: OAuth2Client; status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

  Parameters

  • input: Partial
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { client: OAuth2Client; status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

StaticcreateTokenForClientCredentials

• createTokenForClientCredentials(
      clientId: string,
      clientSecret: string,
      scope?: string[],
      audience?: string,
      userContext?: Record<string, any>,
  ): Promise<ErrorOAuth2 | TokenInfo>

  Parameters

  • clientId: string
  • clientSecret: string
  • Optionalscope: string[]
  • Optionalaudience: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<ErrorOAuth2 | TokenInfo>

StaticdeleteOAuth2Client

• deleteOAuth2Client(
      input: DeleteOAuth2ClientInput,
      userContext?: Record<string, any>,
  ): Promise<
      | { status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

  Parameters

  • input: DeleteOAuth2ClientInput
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

StaticgetOAuth2Client

• getOAuth2Client(
      clientId: string,
      userContext?: Record<string, any>,
  ): Promise<
      | { client: OAuth2Client; status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

  Parameters

  • clientId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { client: OAuth2Client; status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

StaticgetOAuth2Clients

• getOAuth2Clients(
      input: GetOAuth2ClientsInput,
      userContext?: Record<string, any>,
  ): Promise<
      | {
          clients: OAuth2Client[];
          nextPaginationToken?: string;
          status: "OK";
      }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

  Parameters

  • input: GetOAuth2ClientsInput
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | {
          clients: OAuth2Client[];
          nextPaginationToken?: string;
          status: "OK";
      }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

StaticrevokeToken

• revokeToken(
      token: string,
      clientId: string,
      clientSecret?: string,
      userContext?: Record<string, any>,
  ): Promise<ErrorOAuth2 | { status: "OK" }>

  Parameters

  • token: string
  • clientId: string
  • OptionalclientSecret: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<ErrorOAuth2 | { status: "OK" }>

StaticrevokeTokensByClientId

• revokeTokensByClientId(
      clientId: string,
      userContext?: Record<string, any>,
  ): Promise<{ status: "OK" }>

  Parameters

  • clientId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: "OK" }>

StaticrevokeTokensBySessionHandle

• revokeTokensBySessionHandle(
      sessionHandle: string,
      userContext?: Record<string, any>,
  ): Promise<{ status: "OK" }>

  Parameters

  • sessionHandle: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: "OK" }>

StaticupdateOAuth2Client

• updateOAuth2Client(
      input: UpdateOAuth2ClientInput,
      userContext?: Record<string, any>,
  ): Promise<
      | { client: OAuth2Client; status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

  Parameters

  • input: UpdateOAuth2ClientInput
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { client: OAuth2Client; status: "OK" }
      | { error: string; errorDescription: string; status: "ERROR" },
  >

StaticvalidateOAuth2AccessToken

• validateOAuth2AccessToken(
      token: string,
      requirements?: { audience?: string; clientId?: string; scopes?: string[] },
      checkDatabase?: boolean,
      userContext?: Record<string, any>,
  ): Promise<{ payload: JSONObject; status: "OK" }>

  Parameters

  • token: string
  • Optionalrequirements: { audience?: string; clientId?: string; scopes?: string[] }
  • OptionalcheckDatabase: boolean
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ payload: JSONObject; status: "OK" }>

StaticvalidateOAuth2RefreshToken

• validateOAuth2RefreshToken(
      token: string,
      scopes?: string[],
      userContext?: Record<string, any>,
  ): Promise<ErrorOAuth2 | (InstrospectTokenResponse & { status: "OK"; })>

  Parameters

  • token: string
  • Optionalscopes: string[]
  • OptionaluserContext: Record<string, any>

  Returns Promise<ErrorOAuth2 | (InstrospectTokenResponse & { status: "OK"; })>