@ory/client-fetch
v1.22.23
Published
OpenAPI client for @ory/client-fetch
Readme
@ory/[email protected]
A TypeScript SDK client for the playground.projects.oryapis.com API.
Usage
First, install the SDK from npm.
npm install @ory/client-fetch --saveNext, try it out.
import {
Configuration,
CourierApi,
} from '@ory/client-fetch';
import type { GetCourierMessageRequest } from '@ory/client-fetch';
async function example() {
console.log("🚀 Testing @ory/client-fetch SDK...");
const config = new Configuration({
// Configure HTTP bearer authorization: oryAccessToken
accessToken: "YOUR BEARER TOKEN",
});
const api = new CourierApi(config);
const body = {
// string | MessageID is the ID of the message.
id: id_example,
} satisfies GetCourierMessageRequest;
try {
const data = await api.getCourierMessage(body);
console.log(data);
} catch (error) {
console.error(error);
}
}
// Run the test
example().catch(console.error);Documentation
API Endpoints
All URIs are relative to https://playground.projects.oryapis.com
| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- CourierApi | getCourierMessage | GET /admin/courier/messages/{id} | Get a Message CourierApi | listCourierMessages | GET /admin/courier/messages | List Messages EventsApi | createEventStream | POST /projects/{project_id}/eventstreams | Create an event stream for your project. EventsApi | deleteEventStream | DELETE /projects/{project_id}/eventstreams/{event_stream_id} | Remove an event stream from a project EventsApi | listEventStreams | GET /projects/{project_id}/eventstreams | List all event streams for the project. This endpoint is not paginated. EventsApi | setEventStream | PUT /projects/{project_id}/eventstreams/{event_stream_id} | Update an event stream for a project. FrontendApi | createBrowserLoginFlow | GET /self-service/login/browser | Create Login Flow for Browsers FrontendApi | createBrowserLogoutFlow | GET /self-service/logout/browser | Create a Logout URL for Browsers FrontendApi | createBrowserRecoveryFlow | GET /self-service/recovery/browser | Create Recovery Flow for Browsers FrontendApi | createBrowserRegistrationFlow | GET /self-service/registration/browser | Create Registration Flow for Browsers FrontendApi | createBrowserSettingsFlow | GET /self-service/settings/browser | Create Settings Flow for Browsers FrontendApi | createBrowserVerificationFlow | GET /self-service/verification/browser | Create Verification Flow for Browser Clients FrontendApi | createFedcmFlow | GET /self-service/fed-cm/parameters | Get FedCM Parameters FrontendApi | createNativeLoginFlow | GET /self-service/login/api | Create Login Flow for Native Apps FrontendApi | createNativeRecoveryFlow | GET /self-service/recovery/api | Create Recovery Flow for Native Apps FrontendApi | createNativeRegistrationFlow | GET /self-service/registration/api | Create Registration Flow for Native Apps FrontendApi | createNativeSettingsFlow | GET /self-service/settings/api | Create Settings Flow for Native Apps FrontendApi | createNativeVerificationFlow | GET /self-service/verification/api | Create Verification Flow for Native Apps FrontendApi | disableMyOtherSessions | DELETE /sessions | Disable my other sessions FrontendApi | disableMySession | DELETE /sessions/{id} | Disable one of my sessions FrontendApi | exchangeSessionToken | GET /sessions/token-exchange | Exchange Session Token FrontendApi | getFlowError | GET /self-service/errors | Get User-Flow Errors FrontendApi | getLoginFlow | GET /self-service/login/flows | Get Login Flow FrontendApi | getRecoveryFlow | GET /self-service/recovery/flows | Get Recovery Flow FrontendApi | getRegistrationFlow | GET /self-service/registration/flows | Get Registration Flow FrontendApi | getSettingsFlow | GET /self-service/settings/flows | Get Settings Flow FrontendApi | getVerificationFlow | GET /self-service/verification/flows | Get Verification Flow FrontendApi | getWebAuthnJavaScript | GET /.well-known/ory/webauthn.js | Get WebAuthn JavaScript FrontendApi | listMySessions | GET /sessions | Get My Active Sessions FrontendApi | performNativeLogout | DELETE /self-service/logout/api | Perform Logout for Native Apps FrontendApi | toSession | GET /sessions/whoami | Check Who the Current HTTP Session Belongs To FrontendApi | updateFedcmFlow | POST /self-service/fed-cm/token | Submit a FedCM token FrontendApi | updateLoginFlow | POST /self-service/login | Submit a Login Flow FrontendApi | updateLogoutFlow | GET /self-service/logout | Update Logout Flow FrontendApi | updateRecoveryFlow | POST /self-service/recovery | Update Recovery Flow FrontendApi | updateRegistrationFlow | POST /self-service/registration | Update Registration Flow FrontendApi | updateSettingsFlow | POST /self-service/settings | Complete Settings Flow FrontendApi | updateVerificationFlow | POST /self-service/verification | Complete Verification Flow IdentityApi | batchPatchIdentities | PATCH /admin/identities | Create multiple identities IdentityApi | createIdentity | POST /admin/identities | Create an Identity IdentityApi | createRecoveryCodeForIdentity | POST /admin/recovery/code | Create a Recovery Code IdentityApi | createRecoveryLinkForIdentity | POST /admin/recovery/link | Create a Recovery Link IdentityApi | deleteIdentity | DELETE /admin/identities/{id} | Delete an Identity IdentityApi | deleteIdentityCredentials | DELETE /admin/identities/{id}/credentials/{type} | Delete a credential for a specific identity IdentityApi | deleteIdentitySessions | DELETE /admin/identities/{id}/sessions | Delete & Invalidate an Identity's Sessions IdentityApi | disableSession | DELETE /admin/sessions/{id} | Deactivate a Session IdentityApi | extendSession | PATCH /admin/sessions/{id}/extend | Extend a Session IdentityApi | getIdentity | GET /admin/identities/{id} | Get an Identity IdentityApi | getIdentityByExternalID | GET /admin/identities/by/external/{externalID} | Get an Identity by its External ID IdentityApi | getIdentitySchema | GET /schemas/{id} | Get Identity JSON Schema IdentityApi | getSession | GET /admin/sessions/{id} | Get Session IdentityApi | listIdentities | GET /admin/identities | List Identities IdentityApi | listIdentitySchemas | GET /schemas | Get all Identity Schemas IdentityApi | listIdentitySessions | GET /admin/identities/{id}/sessions | List an Identity's Sessions IdentityApi | listSessions | GET /admin/sessions | List All Sessions IdentityApi | patchIdentity | PATCH /admin/identities/{id} | Patch an Identity IdentityApi | updateIdentity | PUT /admin/identities/{id} | Update an Identity JwkApi | createJsonWebKeySet | POST /admin/keys/{set} | Create JSON Web Key JwkApi | deleteJsonWebKey | DELETE /admin/keys/{set}/{kid} | Delete JSON Web Key JwkApi | deleteJsonWebKeySet | DELETE /admin/keys/{set} | Delete JSON Web Key Set JwkApi | getJsonWebKey | GET /admin/keys/{set}/{kid} | Get JSON Web Key JwkApi | getJsonWebKeySet | GET /admin/keys/{set} | Retrieve a JSON Web Key Set JwkApi | setJsonWebKey | PUT /admin/keys/{set}/{kid} | Set JSON Web Key JwkApi | setJsonWebKeySet | PUT /admin/keys/{set} | Update a JSON Web Key Set MetadataApi | getVersion | GET /version | Return Running Software Version. OAuth2Api | acceptOAuth2ConsentRequest | PUT /admin/oauth2/auth/requests/consent/accept | Accept OAuth 2.0 Consent Request OAuth2Api | acceptOAuth2LoginRequest | PUT /admin/oauth2/auth/requests/login/accept | Accept OAuth 2.0 Login Request OAuth2Api | acceptOAuth2LogoutRequest | PUT /admin/oauth2/auth/requests/logout/accept | Accept OAuth 2.0 Session Logout Request OAuth2Api | acceptUserCodeRequest | PUT /admin/oauth2/auth/requests/device/accept | Accepts a device grant user_code request OAuth2Api | createOAuth2Client | POST /admin/clients | Create OAuth 2.0 Client OAuth2Api | deleteOAuth2Client | DELETE /admin/clients/{id} | Delete OAuth 2.0 Client OAuth2Api | deleteOAuth2Token | DELETE /admin/oauth2/tokens | Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client OAuth2Api | deleteTrustedOAuth2JwtGrantIssuer | DELETE /admin/trust/grants/jwt-bearer/issuers/{id} | Delete Trusted OAuth2 JWT Bearer Grant Type Issuer OAuth2Api | getOAuth2Client | GET /admin/clients/{id} | Get an OAuth 2.0 Client OAuth2Api | getOAuth2ConsentRequest | GET /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request OAuth2Api | getOAuth2LoginRequest | GET /admin/oauth2/auth/requests/login | Get OAuth 2.0 Login Request OAuth2Api | getOAuth2LogoutRequest | GET /admin/oauth2/auth/requests/logout | Get OAuth 2.0 Session Logout Request OAuth2Api | getTrustedOAuth2JwtGrantIssuer | GET /admin/trust/grants/jwt-bearer/issuers/{id} | Get Trusted OAuth2 JWT Bearer Grant Type Issuer OAuth2Api | introspectOAuth2Token | POST /admin/oauth2/introspect | Introspect OAuth2 Access and Refresh Tokens OAuth2Api | listOAuth2Clients | GET /admin/clients | List OAuth 2.0 Clients OAuth2Api | listOAuth2ConsentSessions | GET /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject OAuth2Api | listTrustedOAuth2JwtGrantIssuers | GET /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers OAuth2Api | oAuth2Authorize | GET /oauth2/auth | OAuth 2.0 Authorize Endpoint OAuth2Api | oAuth2DeviceFlow | POST /oauth2/device/auth | The OAuth 2.0 Device Authorize Endpoint OAuth2Api | oauth2TokenExchange | POST /oauth2/token | The OAuth 2.0 Token Endpoint OAuth2Api | patchOAuth2Client | PATCH /admin/clients/{id} | Patch OAuth 2.0 Client OAuth2Api | performOAuth2DeviceVerificationFlow | GET /oauth2/device/verify | OAuth 2.0 Device Verification Endpoint OAuth2Api | rejectOAuth2ConsentRequest | PUT /admin/oauth2/auth/requests/consent/reject | Reject OAuth 2.0 Consent Request OAuth2Api | rejectOAuth2LoginRequest | PUT /admin/oauth2/auth/requests/login/reject | Reject OAuth 2.0 Login Request OAuth2Api | rejectOAuth2LogoutRequest | PUT /admin/oauth2/auth/requests/logout/reject | Reject OAuth 2.0 Session Logout Request OAuth2Api | revokeOAuth2ConsentSessions | DELETE /admin/oauth2/auth/sessions/consent | Revoke OAuth 2.0 Consent Sessions of a Subject OAuth2Api | revokeOAuth2LoginSessions | DELETE /admin/oauth2/auth/sessions/login | Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID OAuth2Api | revokeOAuth2Token | POST /oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token OAuth2Api | setOAuth2Client | PUT /admin/clients/{id} | Set OAuth 2.0 Client OAuth2Api | setOAuth2ClientLifespans | PUT /admin/clients/{id}/lifespans | Set OAuth2 Client Token Lifespans OAuth2Api | trustOAuth2JwtGrantIssuer | POST /admin/trust/grants/jwt-bearer/issuers | Trust OAuth2 JWT Bearer Grant Type Issuer OidcApi | createOidcDynamicClient | POST /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration OidcApi | createVerifiableCredential | POST /credentials | Issues a Verifiable Credential OidcApi | deleteOidcDynamicClient | DELETE /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol OidcApi | discoverOidcConfiguration | GET /.well-known/openid-configuration | OpenID Connect Discovery OidcApi | getOidcDynamicClient | GET /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration OidcApi | getOidcUserInfo | GET /userinfo | OpenID Connect Userinfo OidcApi | revokeOidcSession | GET /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout OidcApi | setOidcDynamicClient | PUT /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration PermissionApi | batchCheckPermission | POST /relation-tuples/batch/check | Batch check permissions PermissionApi | checkPermission | GET /relation-tuples/check/openapi | Check a permission PermissionApi | checkPermissionOrError | GET /relation-tuples/check | Check a permission PermissionApi | expandPermissions | GET /relation-tuples/expand | Expand a Relationship into permissions. PermissionApi | postCheckPermission | POST /relation-tuples/check/openapi | Check a permission PermissionApi | postCheckPermissionOrError | POST /relation-tuples/check | Check a permission ProjectApi | createOrganization | POST /projects/{project_id}/organizations | Create an Enterprise SSO Organization ProjectApi | createOrganizationOnboardingPortalLink | POST /projects/{project_id}/organizations/{organization_id}/onboarding-portal-links | Create organization onboarding portal link ProjectApi | createProject | POST /projects | Create a Project ProjectApi | createProjectApiKey | POST /projects/{project}/tokens | Create project API key ProjectApi | deleteOrganization | DELETE /projects/{project_id}/organizations/{organization_id} | Delete Enterprise SSO Organization ProjectApi | deleteOrganizationOnboardingPortalLink | DELETE /projects/{project_id}/organizations/{organization_id}/onboarding-portal-links/{onboarding_portal_link_id} | Delete an organization onboarding portal link ProjectApi | deleteProjectApiKey | DELETE /projects/{project}/tokens/{token_id} | Delete project API key ProjectApi | getOrganization | GET /projects/{project_id}/organizations/{organization_id} | Get Enterprise SSO Organization by ID ProjectApi | getOrganizationOnboardingPortalLinks | GET /projects/{project_id}/organizations/{organization_id}/onboarding-portal-links | Get the organization onboarding portal links ProjectApi | getProject | GET /projects/{project_id} | Get a Project ProjectApi | getProjectMembers | GET /projects/{project}/members | Get all members associated with this project ProjectApi | listOrganizations | GET /projects/{project_id}/organizations | List all Enterprise SSO organizations ProjectApi | listProjectApiKeys | GET /projects/{project}/tokens | List a project's API keys ProjectApi | listProjects | GET /projects | List All Projects ProjectApi | patchProject | PATCH /projects/{project_id} | Patch an Ory Network Project Configuration ProjectApi | patchProjectWithRevision | PATCH /projects/{project_id}/revision/{revision_id} | Patch an Ory Network Project Configuration based on a revision ID ProjectApi | purgeProject | DELETE /projects/{project_id} | Irrecoverably purge a project ProjectApi | removeProjectMember | DELETE /projects/{project}/members/{member} | Remove a member associated with this project ProjectApi | setProject | PUT /projects/{project_id} | Update an Ory Network Project Configuration ProjectApi | updateOrganization | PUT /projects/{project_id}/organizations/{organization_id} | Update an Enterprise SSO Organization ProjectApi | updateOrganizationOnboardingPortalLink | POST /projects/{project_id}/organizations/{organization_id}/onboarding-portal-links/{onboarding_portal_link_id} | Update organization onboarding portal link RelationshipApi | checkOplSyntax | POST /opl/syntax/check | Check the syntax of an OPL file RelationshipApi | createRelationship | PUT /admin/relation-tuples | Create a Relationship RelationshipApi | deleteRelationships | DELETE /admin/relation-tuples | Delete Relationships RelationshipApi | getRelationships | GET /relation-tuples | Query relationships RelationshipApi | listRelationshipNamespaces | GET /namespaces | Query namespaces RelationshipApi | patchRelationships | PATCH /admin/relation-tuples | Patch Multiple Relationships WellknownApi | discoverJsonWebKeys | GET /.well-known/jwks.json | Discover Well-Known JSON Web Keys WorkspaceApi | createWorkspace | POST /workspaces | Create a new workspace WorkspaceApi | createWorkspaceApiKey | POST /workspaces/{workspace}/tokens | Create workspace API key WorkspaceApi | deleteWorkspaceApiKey | DELETE /workspaces/{workspace}/tokens/{token_id} | Delete workspace API key WorkspaceApi | getWorkspace | GET /workspaces/{workspace} | Get a workspace WorkspaceApi | listWorkspaceApiKeys | GET /workspaces/{workspace}/tokens | List a workspace's API keys WorkspaceApi | listWorkspaceProjects | GET /workspaces/{workspace}/projects | List all projects of a workspace WorkspaceApi | listWorkspaces | GET /workspaces | List workspaces the user is a member of WorkspaceApi | updateWorkspace | PUT /workspaces/{workspace} | Update an workspace
Models
- AcceptDeviceUserCodeRequest
- AcceptOAuth2ConsentRequest
- AcceptOAuth2ConsentRequestSession
- AcceptOAuth2LoginRequest
- AccountExperienceColors
- AccountExperienceConfiguration
- ActiveProjectInConsole
- AddProjectToWorkspaceBody
- Attribute
- AttributeFilter
- AttributesCountDatapoint
- AuthenticatorAssuranceLevel
- BasicOrganization
- BatchCheckPermissionBody
- BatchCheckPermissionResult
- BatchPatchIdentitiesResponse
- BillingPeriodBucket
- CheckOplSyntaxResult
- CheckPermissionResult
- CheckPermissionResultWithError
- CloudAccount
- ConsistencyRequestParameters
- ContinueWith
- ContinueWithRecoveryUi
- ContinueWithRecoveryUiFlow
- ContinueWithRedirectBrowserTo
- ContinueWithSetOrySessionToken
- ContinueWithSettingsUi
- ContinueWithSettingsUiFlow
- ContinueWithVerificationUi
- ContinueWithVerificationUiFlow
- CourierMessageStatus
- CourierMessageType
- CreateCustomDomainBody
- CreateEventStreamBody
- CreateFedcmFlowResponse
- CreateIdentityBody
- CreateInviteResponse
- CreateJsonWebKeySet
- CreateOrganizationOnboardingPortalLinkBody
- CreateProjectApiKeyRequest
- CreateProjectBody
- CreateProjectBranding
- CreateProjectMemberInviteBody
- CreateProjectNormalizedPayload
- CreateRecoveryCodeForIdentityBody
- CreateRecoveryLinkForIdentityBody
- CreateRelationshipBody
- CreateSubscriptionBody
- CreateSubscriptionCommon
- CreateVerifiableCredentialRequestBody
- CreateWorkspaceApiKeyBody
- CreateWorkspaceBody
- CreateWorkspaceMemberInviteBody
- CreateWorkspaceSubscriptionBody
- CredentialSupportedDraft00
- CustomDomain
- DeleteMySessionsCount
- DeviceAuthorization
- DeviceUserAuthRequest
- EmailTemplateData
- EmailTemplateDataBody
- ErrorAuthenticatorAssuranceLevelNotSatisfied
- ErrorBrowserLocationChangeRequired
- ErrorFlowReplaced
- ErrorGeneric
- ErrorOAuth2
- EventStream
- ExpandedPermissionTree
- FlowError
- GenericError
- GenericErrorContent
- GenericUsage
- GetAttributesCount
- GetManagedIdentitySchemaLocation
- GetMetricsCount
- GetMetricsEventAttributes
- GetMetricsEventTypes
- GetOrganizationResponse
- GetProjectEvents
- GetProjectEventsBody
- GetProjectMetrics
- GetSessionActivity
- GetVersion200Response
- HealthNotReadyStatus
- HealthStatus
- Identity
- IdentityCredentials
- IdentityCredentialsCode
- IdentityCredentialsCodeAddress
- IdentityCredentialsOidc
- IdentityCredentialsOidcProvider
- IdentityCredentialsPassword
- IdentityPatch
- IdentityPatchResponse
- IdentitySchemaContainer
- IdentitySchemaPreset
- IdentityWithCredentials
- IdentityWithCredentialsOidc
- IdentityWithCredentialsOidcConfig
- IdentityWithCredentialsOidcConfigProvider
- IdentityWithCredentialsPassword
- IdentityWithCredentialsPasswordConfig
- IdentityWithCredentialsSaml
- IdentityWithCredentialsSamlConfig
- IdentityWithCredentialsSamlConfigProvider
- InternalGetProjectBrandingBody
- InternalIsAXWelcomeScreenEnabledForProjectBody
- InternalIsOwnerForProjectBySlug
- InternalIsOwnerForProjectBySlugBody
- IntrospectedOAuth2Token
- InviteTokenBody
- Invoice
- InvoiceDataV1
- IsOwnerForProjectBySlug
- JsonPatch
- JsonWebKey
- JsonWebKeySet
- KetoNamespace
- KeysetPaginationRequestParameters
- KeysetPaginationResponseHeaders
- LineItemV1
- ListEventStreams
- ListInvoicesResponse
- ListOrganizationsResponse
- ListWorkspaceProjects
- ListWorkspaces
- LoginFlow
- LoginFlowState
- LogoutFlow
- ManagedIdentitySchema
- ManagedIdentitySchemaValidationResult
- MemberInvite
- Message
- MessageDispatch
- MetricsDatapoint
- Money
- Namespace
- NeedsPrivilegedSessionError
- NormalizedProject
- NormalizedProjectRevision
- NormalizedProjectRevisionCourierChannel
- NormalizedProjectRevisionHook
- NormalizedProjectRevisionIdentitySchema
- NormalizedProjectRevisionSAMLProvider
- NormalizedProjectRevisionScimClient
- NormalizedProjectRevisionThirdPartyProvider
- NormalizedProjectRevisionTokenizerTemplate
- OAuth2Client
- OAuth2ClientTokenLifespans
- OAuth2ConsentRequest
- OAuth2ConsentRequestOpenIDConnectContext
- OAuth2ConsentSession
- OAuth2LoginRequest
- OAuth2LogoutRequest
- OAuth2RedirectTo
- OAuth2TokenExchange
- OidcConfiguration
- OidcUserInfo
- OnboardingPortalLink
- OnboardingPortalOrganization
- Organization
- OrganizationBody
- OrganizationOnboardingPortalLinksResponse
- ParseError
- PatchIdentitiesBody
- PerformNativeLogoutBody
- PermissionsOnWorkspace
- Plan
- PlanDetails
- PostCheckPermissionBody
- PostCheckPermissionOrErrorBody
- Project
- ProjectApiKey
- ProjectBranding
- ProjectBrandingColors
- ProjectBrandingTheme
- ProjectCors
- ProjectEventsDatapoint
- ProjectHost
- ProjectMember
- ProjectMetadata
- ProjectServiceAccountExperience
- ProjectServiceIdentity
- ProjectServiceOAuth2
- ProjectServicePermission
- ProjectServices
- Provider
- QuotaUsage
- RFC6749ErrorJson
- RecoveryCodeForIdentity
- RecoveryFlow
- RecoveryFlowState
- RecoveryIdentityAddress
- RecoveryLinkForIdentity
- RegistrationFlow
- RegistrationFlowState
- RejectOAuth2Request
- RelationQuery
- Relationship
- RelationshipNamespaces
- RelationshipPatch
- Relationships
- RevisionAccountExperienceCustomTranslation
- SchemaPatch
- SelfServiceFlowExpiredError
- Session
- SessionActivityDatapoint
- SessionAuthenticationMethod
- SessionDevice
- SetActiveProjectInConsoleBody
- SetCustomDomainBody
- SetEventStreamBody
- SetOrganizationFromOnboardingPortalLinkBody
- SetProject
- SetProjectBrandingThemeBody
- SettingsFlow
- SettingsFlowState
- SourcePosition
- SubjectSet
- Subscription
- SuccessfulCodeExchangeResponse
- SuccessfulNativeLogin
- SuccessfulNativeRegistration
- SuccessfulProjectUpdate
- TaxLineItem
- TimeInterval
- TokenPagination
- TokenPaginationHeaders
- TokenPaginationRequestParameters
- TokenPaginationResponseHeaders
- TrustOAuth2JwtGrantIssuer
- TrustedOAuth2JwtGrantIssuer
- TrustedOAuth2JwtGrantJsonWebKey
- UiContainer
- UiNode
- UiNodeAnchorAttributes
- UiNodeAttributes
- UiNodeDivisionAttributes
- UiNodeImageAttributes
- UiNodeInputAttributes
- UiNodeMeta
- UiNodeScriptAttributes
- UiNodeTextAttributes
- UiText
- UpdateFedcmFlowBody
- UpdateIdentityBody
- UpdateLoginFlowBody
- UpdateLoginFlowWithCodeMethod
- UpdateLoginFlowWithIdentifierFirstMethod
- UpdateLoginFlowWithLookupSecretMethod
- UpdateLoginFlowWithOidcMethod
- UpdateLoginFlowWithPasskeyMethod
- UpdateLoginFlowWithPasswordMethod
- UpdateLoginFlowWithSamlMethod
- UpdateLoginFlowWithTotpMethod
- UpdateLoginFlowWithWebAuthnMethod
- UpdateOrganizationOnboardingPortalLinkBody
- UpdateRecoveryFlowBody
- UpdateRecoveryFlowWithCodeMethod
- UpdateRecoveryFlowWithLinkMethod
- UpdateRegistrationFlowBody
- UpdateRegistrationFlowWithCodeMethod
- UpdateRegistrationFlowWithOidcMethod
- UpdateRegistrationFlowWithPasskeyMethod
- UpdateRegistrationFlowWithPasswordMethod
- UpdateRegistrationFlowWithProfileMethod
- UpdateRegistrationFlowWithSamlMethod
- UpdateRegistrationFlowWithWebAuthnMethod
- UpdateSettingsFlowBody
- UpdateSettingsFlowWithLookupMethod
- UpdateSettingsFlowWithOidcMethod
- UpdateSettingsFlowWithPasskeyMethod
- UpdateSettingsFlowWithPasswordMethod
- UpdateSettingsFlowWithProfileMethod
- UpdateSettingsFlowWithSamlMethod
- UpdateSettingsFlowWithTotpMethod
- UpdateSettingsFlowWithWebAuthnMethod
- UpdateSubscriptionBody
- UpdateVerificationFlowBody
- UpdateVerificationFlowWithCodeMethod
- UpdateVerificationFlowWithLinkMethod
- UpdateWorkspaceBody
- Usage
- VerifiableCredentialPrimingResponse
- VerifiableCredentialProof
- VerifiableCredentialResponse
- VerifiableIdentityAddress
- VerificationFlow
- VerificationFlowState
- VerifyUserCodeRequest
- Version
- Warning
- Workspace
- WorkspaceApiKey
Authorization
Authentication schemes defined for the API:
basic
- Type: HTTP basic authentication
bearer
- Type: HTTP Bearer Token authentication
oauth2 accessCode
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://hydra.demo.ory.sh/oauth2/auth
- Scopes:
offline: A scope required when requesting refresh tokens (alias for `offline_access`)offline_access: A scope required when requesting refresh tokensopenid: Request an OpenID Connect ID Token
oryAccessToken
- Type: HTTP Bearer Token authentication
oryWorkspaceApiKey
- Type: HTTP Bearer Token authentication
About
This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:
- API version:
v1.22.23 - Package version:
v1.22.23 - Generator version:
7.17.0 - Build package:
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen
The generated npm module supports the following:
- Environments
- Node.js
- Webpack
- Browserify
- Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
- Module systems
- CommonJS
- ES6 module system
Development
Building
To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:
npm install
npm run buildPublishing
Once you've built the package, you can publish it to npm:
npm publish