Class default

constructor

• new default(): default

  Returns default

StaticError

Staticinit

StaticcreateLoginRequest

• createLoginRequest(
      input: {
          acsURL: string;
          clientId: string;
          redirectURI: string;
          state?: string;
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<
      | { redirectURI: string; status: "OK" }
      | { status: "INVALID_CLIENT_ERROR" },
  >

  Parameters

  • input: {
        acsURL: string;
        clientId: string;
        redirectURI: string;
        state?: string;
        tenantId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<
      | { redirectURI: string; status: "OK" }
      | { status: "INVALID_CLIENT_ERROR" },
  >

StaticcreateOrUpdateClient

• createOrUpdateClient(
      input: {
          allowIDPInitiatedLogin?: boolean;
          clientId?: string;
          clientSecret?: string;
          defaultRedirectURI: string;
          enableRequestSigning?: boolean;
          metadataXML: string;
          redirectURIs: string[];
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<
      | { status: "OK" } & SAMLClient
      | { status: "INVALID_METADATA_XML_ERROR" | "DUPLICATE_IDP_ENTITY_ERROR" },
  >

  Parameters

  • input: {
        allowIDPInitiatedLogin?: boolean;
        clientId?: string;
        clientSecret?: string;
        defaultRedirectURI: string;
        enableRequestSigning?: boolean;
        metadataXML: string;
        redirectURIs: string[];
        tenantId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<
      | { status: "OK" } & SAMLClient
      | { status: "INVALID_METADATA_XML_ERROR" | "DUPLICATE_IDP_ENTITY_ERROR" },
  >

StaticgetUserInfo

• getUserInfo(
      input: {
          accessToken: string;
          clientId: string;
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<
      | {
          claims: Record<string, any>;
          email: string;
          status: "OK";
          sub: string;
      }
      | { status: "INVALID_TOKEN_ERROR" },
  >

  Parameters

  • input: {
        accessToken: string;
        clientId: string;
        tenantId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<
      | {
          claims: Record<string, any>;
          email: string;
          status: "OK";
          sub: string;
      }
      | { status: "INVALID_TOKEN_ERROR" },
  >

StaticlistClients

• listClients(
      input: { tenantId: string; userContext?: Record<string, any> },
  ): Promise<{ clients: SAMLClient[]; status: "OK" }>

  Parameters

  • input: { tenantId: string; userContext?: Record<string, any> }

  Returns Promise<{ clients: SAMLClient[]; status: "OK" }>

StaticremoveClient

• removeClient(
      input: {
          clientId: string;
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<{ didExist: boolean; status: "OK" }>

  Parameters

  • input: { clientId: string; tenantId: string; userContext?: Record<string, any> }

  Returns Promise<{ didExist: boolean; status: "OK" }>

StaticverifySAMLResponse

• verifySAMLResponse(
      input: {
          relayState: undefined | string;
          samlResponse: string;
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<
      | { redirectURI: string; status: "OK" }
      | {
          status:
              | "INVALID_CLIENT_ERROR"
              | "SAML_RESPONSE_VERIFICATION_FAILED_ERROR"
              | "INVALID_RELAY_STATE_ERROR"
              | "IDP_LOGIN_DISALLOWED_ERROR";
      },
  >

  Parameters

  • input: {
        relayState: undefined | string;
        samlResponse: string;
        tenantId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<
      | { redirectURI: string; status: "OK" }
      | {
          status:
              | "INVALID_CLIENT_ERROR"
              | "SAML_RESPONSE_VERIFICATION_FAILED_ERROR"
              | "INVALID_RELAY_STATE_ERROR"
              | "IDP_LOGIN_DISALLOWED_ERROR";
      },
  >