@platform/sdk-identity
Typed TypeScript client for services/identity. The page is generated from the SDK package source plus its generated OpenAPI types.
Installation
npm install @platform/sdk-identityYou’ll also need the shared auth/client helpers:
npm install @platform/hosts @platform/sdkQuick start
import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createIdentityClient } from "@platform/sdk-identity";
const loop = new LoopClient({
clientId: process.env.LOOP_CLIENT_ID!,
clientSecret: process.env.LOOP_CLIENT_SECRET!,
redirectUri: "https://your-app.example.com/auth/loop/callback",
});
const identity = createIdentityClient({
baseUrl: platformHost({ service: SERVICE_NAMES.IDENTITY }),
accessToken: tokens.access_token,
});Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.
Convenience helpers
admin.oauthClients.get
Underlying REST endpoint: GET /v1/admin/oauth-clients/\{clientId\}
Parameters
clientId: string
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.oauthClients.get("<clientId>");admin.oauthClients.list
Underlying REST endpoint: GET /v1/admin/oauth-clients
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.oauthClients.list();admin.oauthClients.register
Underlying REST endpoint: POST /v1/admin/oauth-clients
Parameters
body: RegisterBody
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.oauthClients.register({
/* RegisterBody */
});admin.oauthClients.remove
Underlying REST endpoint: DELETE /v1/admin/oauth-clients/\{clientId\}
Parameters
clientId: string
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.oauthClients.remove("<clientId>");admin.oauthClients.rotateSecret
Underlying REST endpoint: POST /v1/admin/oauth-clients/\{clientId\}/rotate-secret
Parameters
clientId: string
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}/rotate-secret"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.oauthClients.rotateSecret("<clientId>");admin.oauthClients.update
Underlying REST endpoint: PATCH /v1/admin/oauth-clients/\{clientId\}
Parameters
clientId: stringbody: UpdateBody
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.oauthClients.update("<clientId>", {
/* UpdateBody */
});admin.users.get
Underlying REST endpoint: GET /v1/admin/users/\{userId\}
Parameters
userId: string
Return type
Promise<{
data?: paths["/v1/admin/users/{userId}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.users.get("<userId>");admin.users.list
Underlying REST endpoint: GET /v1/admin/users
Parameters
query?: ListUsersQuery
Return type
Promise<{
data?: paths["/v1/admin/users"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.admin.users.list({
/* ListUsersQuery */
});consumer.confirmEmailChange
Underlying REST endpoint: POST /v1/users/me/email-change-confirm
Parameters
input: EmailChangeConfirmInput
Return type
Promise<Result<EmailChangeConfirmResponse>>Example
const result = await identity.consumer.confirmEmailChange({
/* EmailChangeConfirmInput */
});consumer.confirmTotp
Underlying REST endpoint: POST /v1/users/me/mfa/totp/confirm
Parameters
input: { method_id: string; code: string; }
Return type
Promise<Result<MfaMethod>>Example
const result = await identity.consumer.confirmTotp({
/* { method_id: string; code: string; } */
});consumer.createAddress
Underlying REST endpoint: POST /v1/users/me/addresses
Parameters
input: CreateAddressInput
Return type
Promise<Result<Address>>Example
const result = await identity.consumer.createAddress({
/* CreateAddressInput */
});consumer.deleteAddress
Underlying REST endpoint: DELETE /v1/users/me/addresses/\{address_id\}
Parameters
id: string
Return type
Promise<Result<{ deleted: true }>>Example
const result = await identity.consumer.deleteAddress("<id>");consumer.deleteMfaMethod
Underlying REST endpoint: DELETE /v1/users/me/mfa/\{method_id\}
Parameters
methodId: string
Return type
Promise<Result<{ deleted: true }>>Example
const result = await identity.consumer.deleteMfaMethod("<methodId>");consumer.getBackupCodesSummary
Underlying REST endpoint: GET /v1/users/me/backup-codes
Parameters
None
Return type
Promise<Result<BackupCodesSummary>>Example
const result = await identity.consumer.getBackupCodesSummary();consumer.getInternalTeam
Underlying REST endpoint: GET /v1/internal-team
Parameters
None
Return type
Promise<Result<InternalTeamList>>Example
const result = await identity.consumer.getInternalTeam();consumer.getMe
Underlying REST endpoint: GET /v1/users/me
Parameters
None
Return type
Promise<Result<FullProfile>>Example
const result = await identity.consumer.getMe();consumer.getMemberProfile
Underlying REST endpoint: GET /v1/users/\{user_id\}/profile
Parameters
userId: string
Return type
Promise<Result<PublicProfile>>Example
const result = await identity.consumer.getMemberProfile("<userId>");consumer.getSettings
Underlying REST endpoint: GET /v1/users/me/settings
Parameters
None
Return type
Promise<Result<Settings>>Example
const result = await identity.consumer.getSettings();consumer.getUserBadges
Underlying REST endpoint: GET /v1/users/\{user_id\}/badges
Parameters
userId: string
Return type
Promise<Result<BadgesResponse>>Example
const result = await identity.consumer.getUserBadges("<userId>");consumer.initTotp
Underlying REST endpoint: POST /v1/users/me/mfa/totp/init
Parameters
input?: { label?: string; issuer?: string }
Return type
Promise<Result<TotpInitResponse>>Example
const result = await identity.consumer.initTotp({
/* { label?: string; issuer?: string } */
});consumer.listActiveSessions
Underlying REST endpoint: GET /v1/users/me/sessions
Parameters
None
Return type
Promise<Result<SessionList>>Example
const result = await identity.consumer.listActiveSessions();consumer.listAddresses
Underlying REST endpoint: GET /v1/users/me/addresses
Parameters
None
Return type
Promise<Result<AddressList>>Example
const result = await identity.consumer.listAddresses();consumer.listMfaMethods
Underlying REST endpoint: GET /v1/users/me/mfa
Parameters
None
Return type
Promise<Result<MfaList>>Example
const result = await identity.consumer.listMfaMethods();consumer.listMyGrants
Underlying REST endpoint: GET /v1/me/grants
Parameters
None
Return type
Promise<Result<MemberGrantList>>Example
const result = await identity.consumer.listMyGrants();consumer.regenerateBackupCodes
Underlying REST endpoint: POST /v1/users/me/backup-codes/regenerate
Parameters
None
Return type
Promise<Result<BackupCodesRegen>>Example
const result = await identity.consumer.regenerateBackupCodes();consumer.requestEmailChange
Underlying REST endpoint: POST /v1/users/me/email-change-request
Parameters
input: EmailChangeRequestInput
Return type
Promise<Result<EmailChangeRequestResponse>>Example
const result = await identity.consumer.requestEmailChange({
/* EmailChangeRequestInput */
});consumer.resetOnboarding
Underlying REST endpoint: POST /v1/me/reset/onboarding
Parameters
None
Return type
Promise<Result<ResetOnboardingResponse>>Example
const result = await identity.consumer.resetOnboarding();consumer.resetSettings
Underlying REST endpoint: POST /v1/me/reset/settings
Parameters
None
Return type
Promise<Result<ResetSettingsResponse>>Example
const result = await identity.consumer.resetSettings();consumer.revokeMyGrant
Underlying REST endpoint: DELETE /v1/me/grants/\{id\}
Parameters
id: string
Return type
Promise<Result<{ revoked: true }>>Example
const result = await identity.consumer.revokeMyGrant("<id>");consumer.setDefaultAddress
Underlying REST endpoint: POST /v1/users/me/addresses/\{address_id\}/set-default
Parameters
id: string
Return type
Promise<Result<Address>>Example
const result = await identity.consumer.setDefaultAddress("<id>");consumer.signOutOtherSessions
Underlying REST endpoint: POST /v1/users/me/sessions/sign-out-others
Parameters
None
Return type
Promise<Result<{ revoked: number }>>Example
const result = await identity.consumer.signOutOtherSessions();consumer.updateAddress
Underlying REST endpoint: PATCH /v1/users/me/addresses/\{address_id\}
Parameters
id: stringinput: UpdateAddressInput
Return type
Promise<Result<Address>>Example
const result = await identity.consumer.updateAddress("<id>", {
/* UpdateAddressInput */
});consumer.updateProfile
Underlying REST endpoint: PATCH /v1/users/me/profile
Parameters
input: UpdateProfileInput
Return type
Promise<Result<UpdateProfileResponse>>Example
const result = await identity.consumer.updateProfile({
/* UpdateProfileInput */
});consumer.updateSettings
Underlying REST endpoint: PATCH /v1/users/me/settings
Parameters
input: UpdateSettingsInput
Return type
Promise<Result<Settings>>Example
const result = await identity.consumer.updateSettings({
/* UpdateSettingsInput */
});Endpoint calls
GET /.well-known/jwks.json
Underlying REST endpoint: GET /.well-known/jwks.json
Parameters
None
Return type
Promise<{
data?: paths["/.well-known/jwks.json"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/.well-known/jwks.json");GET /.well-known/openid-configuration
Underlying REST endpoint: GET /.well-known/openid-configuration
Parameters
None
Return type
Promise<{
data?: paths["/.well-known/openid-configuration"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/.well-known/openid-configuration");GET /readyz
Underlying REST endpoint: GET /readyz
Parameters
None
Return type
Promise<{
data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/readyz");GET /v1/admin/app-directory/{clientId}
Underlying REST endpoint: GET /v1/admin/app-directory/\{clientId\}
Parameters
path: paths["/v1/admin/app-directory/{clientId}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/app-directory/{clientId}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/app-directory/{clientId}", {
params: {
path: {
clientId: "<clientId>",
},
},
});PATCH /v1/admin/app-directory/{clientId}/baa
Underlying REST endpoint: PATCH /v1/admin/app-directory/\{clientId\}/baa
Parameters
path: paths["/v1/admin/app-directory/{clientId}/baa"]["patch"]["parameters"]["path"]body: paths["/v1/admin/app-directory/{clientId}/baa"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/app-directory/{clientId}/baa"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/admin/app-directory/{clientId}/baa", {
params: {
path: {
clientId: "<clientId>",
},
},
body: {
/* paths["/v1/admin/app-directory/{clientId}/baa"]["patch"]["requestBody"]["content"]["application/json"] */
},
});PATCH /v1/admin/app-directory/{clientId}/listing
Underlying REST endpoint: PATCH /v1/admin/app-directory/\{clientId\}/listing
Parameters
path: paths["/v1/admin/app-directory/{clientId}/listing"]["patch"]["parameters"]["path"]body: paths["/v1/admin/app-directory/{clientId}/listing"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/app-directory/{clientId}/listing"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/admin/app-directory/{clientId}/listing", {
params: {
path: {
clientId: "<clientId>",
},
},
body: {
/* paths["/v1/admin/app-directory/{clientId}/listing"]["patch"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/attio-sync/candidates
Underlying REST endpoint: GET /v1/admin/attio-sync/candidates
Parameters
query?: paths["/v1/admin/attio-sync/candidates"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/attio-sync/candidates"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/attio-sync/candidates", {
params: {
query: {
/* paths["/v1/admin/attio-sync/candidates"]["get"]["parameters"]["query"] */
},
},
});GET /v1/admin/oauth-clients
Underlying REST endpoint: GET /v1/admin/oauth-clients
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/oauth-clients");POST /v1/admin/oauth-clients
Underlying REST endpoint: POST /v1/admin/oauth-clients
Parameters
body: paths["/v1/admin/oauth-clients"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/oauth-clients", {
body: {
/* paths["/v1/admin/oauth-clients"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/admin/oauth-clients/{clientId}
Underlying REST endpoint: DELETE /v1/admin/oauth-clients/\{clientId\}
Parameters
path: paths["/v1/admin/oauth-clients/{clientId}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.DELETE("/v1/admin/oauth-clients/{clientId}", {
params: {
path: {
clientId: "<clientId>",
},
},
});GET /v1/admin/oauth-clients/{clientId}
Underlying REST endpoint: GET /v1/admin/oauth-clients/\{clientId\}
Parameters
path: paths["/v1/admin/oauth-clients/{clientId}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/oauth-clients/{clientId}", {
params: {
path: {
clientId: "<clientId>",
},
},
});PATCH /v1/admin/oauth-clients/{clientId}
Underlying REST endpoint: PATCH /v1/admin/oauth-clients/\{clientId\}
Parameters
path: paths["/v1/admin/oauth-clients/{clientId}"]["patch"]["parameters"]["path"]body: paths["/v1/admin/oauth-clients/{clientId}"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/admin/oauth-clients/{clientId}", {
params: {
path: {
clientId: "<clientId>",
},
},
body: {
/* paths["/v1/admin/oauth-clients/{clientId}"]["patch"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/oauth-clients/{clientId}/rotate-secret
Underlying REST endpoint: POST /v1/admin/oauth-clients/\{clientId\}/rotate-secret
Parameters
path: paths["/v1/admin/oauth-clients/{clientId}/rotate-secret"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/oauth-clients/{clientId}/rotate-secret"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/oauth-clients/{clientId}/rotate-secret", {
params: {
path: {
clientId: "<clientId>",
},
},
});GET /v1/admin/researcher-grants
Underlying REST endpoint: GET /v1/admin/researcher-grants
Parameters
query?: paths["/v1/admin/researcher-grants"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/researcher-grants"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/researcher-grants", {
params: {
query: {
/* paths["/v1/admin/researcher-grants"]["get"]["parameters"]["query"] */
},
},
});POST /v1/admin/researcher-grants
Underlying REST endpoint: POST /v1/admin/researcher-grants
Parameters
body: paths["/v1/admin/researcher-grants"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/researcher-grants"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/researcher-grants", {
body: {
/* paths["/v1/admin/researcher-grants"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/researcher-grants/{id}/approve
Underlying REST endpoint: POST /v1/admin/researcher-grants/\{id\}/approve
Parameters
path: paths["/v1/admin/researcher-grants/{id}/approve"]["post"]["parameters"]["path"]body?: paths["/v1/admin/researcher-grants/{id}/approve"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/researcher-grants/{id}/approve"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/researcher-grants/{id}/approve", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/researcher-grants/{id}/approve"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/researcher-grants/{id}/deny
Underlying REST endpoint: POST /v1/admin/researcher-grants/\{id\}/deny
Parameters
path: paths["/v1/admin/researcher-grants/{id}/deny"]["post"]["parameters"]["path"]body?: paths["/v1/admin/researcher-grants/{id}/deny"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/researcher-grants/{id}/deny"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/researcher-grants/{id}/deny", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/researcher-grants/{id}/deny"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/researcher-grants/{id}/revoke
Underlying REST endpoint: POST /v1/admin/researcher-grants/\{id\}/revoke
Parameters
path: paths["/v1/admin/researcher-grants/{id}/revoke"]["post"]["parameters"]["path"]body?: paths["/v1/admin/researcher-grants/{id}/revoke"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/researcher-grants/{id}/revoke"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/researcher-grants/{id}/revoke", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/researcher-grants/{id}/revoke"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/staff
Underlying REST endpoint: GET /v1/admin/staff
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/staff"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/staff");PATCH /v1/admin/staff/{id}
Underlying REST endpoint: PATCH /v1/admin/staff/\{id\}
Parameters
path: paths["/v1/admin/staff/{id}"]["patch"]["parameters"]["path"]body: paths["/v1/admin/staff/{id}"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/staff/{id}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/admin/staff/{id}", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/staff/{id}"]["patch"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/staff/{id}/remove
Underlying REST endpoint: POST /v1/admin/staff/\{id\}/remove
Parameters
path: paths["/v1/admin/staff/{id}/remove"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/staff/{id}/remove"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/staff/{id}/remove", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/admin/staff/{id}/resend
Underlying REST endpoint: POST /v1/admin/staff/\{id\}/resend
Parameters
path: paths["/v1/admin/staff/{id}/resend"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/staff/{id}/resend"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/staff/{id}/resend", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/admin/staff/{id}/revoke
Underlying REST endpoint: POST /v1/admin/staff/\{id\}/revoke
Parameters
path: paths["/v1/admin/staff/{id}/revoke"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/staff/{id}/revoke"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/staff/{id}/revoke", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/admin/staff/{id}/suspend
Underlying REST endpoint: POST /v1/admin/staff/\{id\}/suspend
Parameters
path: paths["/v1/admin/staff/{id}/suspend"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/staff/{id}/suspend"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/staff/{id}/suspend", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/admin/staff/invite
Underlying REST endpoint: POST /v1/admin/staff/invite
Parameters
body: paths["/v1/admin/staff/invite"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/staff/invite"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/staff/invite", {
body: {
/* paths["/v1/admin/staff/invite"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/staff/resolve
Underlying REST endpoint: POST /v1/admin/staff/resolve
Parameters
body: paths["/v1/admin/staff/resolve"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/staff/resolve"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/staff/resolve", {
body: {
/* paths["/v1/admin/staff/resolve"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/users
Underlying REST endpoint: GET /v1/admin/users
Parameters
query?: paths["/v1/admin/users"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/users"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/users", {
params: {
query: {
/* paths["/v1/admin/users"]["get"]["parameters"]["query"] */
},
},
});POST /v1/admin/users/{user_id}/ban
Underlying REST endpoint: POST /v1/admin/users/\{user_id\}/ban
Parameters
path: paths["/v1/admin/users/{user_id}/ban"]["post"]["parameters"]["path"]body: paths["/v1/admin/users/{user_id}/ban"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/users/{user_id}/ban"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/users/{user_id}/ban", {
params: {
path: {
user_id: "<user_id>",
},
},
body: {
/* paths["/v1/admin/users/{user_id}/ban"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/users/{user_id}/moderation
Underlying REST endpoint: GET /v1/admin/users/\{user_id\}/moderation
Parameters
path: paths["/v1/admin/users/{user_id}/moderation"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/users/{user_id}/moderation"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/users/{user_id}/moderation", {
params: {
path: {
user_id: "<user_id>",
},
},
});GET /v1/admin/users/{user_id}/settings
Underlying REST endpoint: GET /v1/admin/users/\{user_id\}/settings
Parameters
path: paths["/v1/admin/users/{user_id}/settings"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/users/{user_id}/settings"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/users/{user_id}/settings", {
params: {
path: {
user_id: "<user_id>",
},
},
});POST /v1/admin/users/{user_id}/suspend
Underlying REST endpoint: POST /v1/admin/users/\{user_id\}/suspend
Parameters
path: paths["/v1/admin/users/{user_id}/suspend"]["post"]["parameters"]["path"]body: paths["/v1/admin/users/{user_id}/suspend"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/users/{user_id}/suspend"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/admin/users/{user_id}/suspend", {
params: {
path: {
user_id: "<user_id>",
},
},
body: {
/* paths["/v1/admin/users/{user_id}/suspend"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/users/{userId}
Underlying REST endpoint: GET /v1/admin/users/\{userId\}
Parameters
path: paths["/v1/admin/users/{userId}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/users/{userId}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/users/{userId}", {
params: {
path: {
userId: "<userId>",
},
},
});GET /v1/admin/users/lookup
Underlying REST endpoint: GET /v1/admin/users/lookup
Parameters
query: paths["/v1/admin/users/lookup"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/users/lookup"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/admin/users/lookup", {
params: {
query: {
/* paths["/v1/admin/users/lookup"]["get"]["parameters"]["query"] */
},
},
});GET /v1/app-directory
Underlying REST endpoint: GET /v1/app-directory
Parameters
None
Return type
Promise<{
data?: paths["/v1/app-directory"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/app-directory");POST /v1/auth/sso/loopbio
Underlying REST endpoint: POST /v1/auth/sso/loopbio
Parameters
None
Return type
Promise<{
data?: paths["/v1/auth/sso/loopbio"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/auth/sso/loopbio");GET /v1/entitlements/{user_id}
Underlying REST endpoint: GET /v1/entitlements/\{user_id\}
Parameters
path: paths["/v1/entitlements/{user_id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/entitlements/{user_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/entitlements/{user_id}", {
params: {
path: {
user_id: "<user_id>",
},
},
});GET /v1/entitlements/{user_id}/check/{product_key}
Underlying REST endpoint: GET /v1/entitlements/\{user_id\}/check/\{product_key\}
Parameters
path: paths["/v1/entitlements/{user_id}/check/{product_key}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/entitlements/{user_id}/check/{product_key}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/entitlements/{user_id}/check/{product_key}", {
params: {
path: {
user_id: "<user_id>",
product_key: "<product_key>",
},
},
});POST /v1/erasure-requests
Underlying REST endpoint: POST /v1/erasure-requests
Parameters
body: paths["/v1/erasure-requests"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/erasure-requests"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/erasure-requests", {
body: {
/* paths["/v1/erasure-requests"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/erasure-requests/{request_id}
Underlying REST endpoint: GET /v1/erasure-requests/\{request_id\}
Parameters
path: paths["/v1/erasure-requests/{request_id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/erasure-requests/{request_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/erasure-requests/{request_id}", {
params: {
path: {
request_id: "<request_id>",
},
},
});PATCH /v1/erasure-requests/{request_id}
Underlying REST endpoint: PATCH /v1/erasure-requests/\{request_id\}
Parameters
path: paths["/v1/erasure-requests/{request_id}"]["patch"]["parameters"]["path"]body: paths["/v1/erasure-requests/{request_id}"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/erasure-requests/{request_id}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/erasure-requests/{request_id}", {
params: {
path: {
request_id: "<request_id>",
},
},
body: {
/* paths["/v1/erasure-requests/{request_id}"]["patch"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/internal-team
Underlying REST endpoint: GET /v1/internal-team
Parameters
None
Return type
Promise<{
data?: paths["/v1/internal-team"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/internal-team");GET /v1/me/grants
Underlying REST endpoint: GET /v1/me/grants
Parameters
None
Return type
Promise<{
data?: paths["/v1/me/grants"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/me/grants");DELETE /v1/me/grants/{id}
Underlying REST endpoint: DELETE /v1/me/grants/\{id\}
Parameters
path: paths["/v1/me/grants/{id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: void;
error?: unknown;
response: Response;
}>Example
const result = await identity.DELETE("/v1/me/grants/{id}", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/me/reset/onboarding
Underlying REST endpoint: POST /v1/me/reset/onboarding
Parameters
None
Return type
Promise<{
data?: paths["/v1/me/reset/onboarding"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/me/reset/onboarding");POST /v1/me/reset/settings
Underlying REST endpoint: POST /v1/me/reset/settings
Parameters
None
Return type
Promise<{
data?: paths["/v1/me/reset/settings"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/me/reset/settings");GET /v1/oauth/authorize
Underlying REST endpoint: GET /v1/oauth/authorize
Parameters
None
Return type
Promise<{
data?: void;
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/oauth/authorize");POST /v1/oauth/introspect
Underlying REST endpoint: POST /v1/oauth/introspect
Parameters
None
Return type
Promise<{
data?: paths["/v1/oauth/introspect"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/oauth/introspect");POST /v1/oauth/revoke
Underlying REST endpoint: POST /v1/oauth/revoke
Parameters
None
Return type
Promise<{
data?: void;
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/oauth/revoke");POST /v1/oauth/token
Underlying REST endpoint: POST /v1/oauth/token
Parameters
None
Return type
Promise<{
data?: paths["/v1/oauth/token"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/oauth/token");POST /v1/rbac/assignments
Underlying REST endpoint: POST /v1/rbac/assignments
Parameters
body: paths["/v1/rbac/assignments"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/rbac/assignments"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/rbac/assignments", {
body: {
/* paths["/v1/rbac/assignments"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/rbac/assignments/revoke
Underlying REST endpoint: POST /v1/rbac/assignments/revoke
Parameters
body: paths["/v1/rbac/assignments/revoke"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/rbac/assignments/revoke"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/rbac/assignments/revoke", {
body: {
/* paths["/v1/rbac/assignments/revoke"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/rbac/check
Underlying REST endpoint: GET /v1/rbac/check
Parameters
query: paths["/v1/rbac/check"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/rbac/check"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/rbac/check", {
params: {
query: {
/* paths["/v1/rbac/check"]["get"]["parameters"]["query"] */
},
},
});GET /v1/rbac/roles
Underlying REST endpoint: GET /v1/rbac/roles
Parameters
query: paths["/v1/rbac/roles"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/rbac/roles"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/rbac/roles", {
params: {
query: {
/* paths["/v1/rbac/roles"]["get"]["parameters"]["query"] */
},
},
});POST /v1/sessions/verify
Underlying REST endpoint: POST /v1/sessions/verify
Parameters
body: paths["/v1/sessions/verify"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/sessions/verify"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/sessions/verify", {
body: {
/* paths["/v1/sessions/verify"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/tokens
Underlying REST endpoint: POST /v1/tokens
Parameters
None
Return type
Promise<{
data?: paths["/v1/tokens"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/tokens");POST /v1/tokens/exchange
Underlying REST endpoint: POST /v1/tokens/exchange
Parameters
None
Return type
Promise<{
data?: paths["/v1/tokens/exchange"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/tokens/exchange");GET /v1/users/{user_id}/badges
Underlying REST endpoint: GET /v1/users/\{user_id\}/badges
Parameters
path: paths["/v1/users/{user_id}/badges"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/users/{user_id}/badges"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/{user_id}/badges", {
params: {
path: {
user_id: "<user_id>",
},
},
});GET /v1/users/{user_id}/profile
Underlying REST endpoint: GET /v1/users/\{user_id\}/profile
Parameters
path: paths["/v1/users/{user_id}/profile"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/users/{user_id}/profile"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/{user_id}/profile", {
params: {
path: {
user_id: "<user_id>",
},
},
});GET /v1/users/by-handle/{handle}
Underlying REST endpoint: GET /v1/users/by-handle/\{handle\}
Parameters
path: paths["/v1/users/by-handle/{handle}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/users/by-handle/{handle}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/by-handle/{handle}", {
params: {
path: {
handle: "<handle>",
},
},
});GET /v1/users/handle-available
Underlying REST endpoint: GET /v1/users/handle-available
Parameters
query: paths["/v1/users/handle-available"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/users/handle-available"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/handle-available", {
params: {
query: {
/* paths["/v1/users/handle-available"]["get"]["parameters"]["query"] */
},
},
});GET /v1/users/me
Underlying REST endpoint: GET /v1/users/me
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me");GET /v1/users/me/addresses
Underlying REST endpoint: GET /v1/users/me/addresses
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/addresses"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me/addresses");POST /v1/users/me/addresses
Underlying REST endpoint: POST /v1/users/me/addresses
Parameters
body: paths["/v1/users/me/addresses"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/addresses"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/addresses", {
body: {
/* paths["/v1/users/me/addresses"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/users/me/addresses/{address_id}
Underlying REST endpoint: DELETE /v1/users/me/addresses/\{address_id\}
Parameters
path: paths["/v1/users/me/addresses/{address_id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/users/me/addresses/{address_id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.DELETE("/v1/users/me/addresses/{address_id}", {
params: {
path: {
address_id: "<address_id>",
},
},
});PATCH /v1/users/me/addresses/{address_id}
Underlying REST endpoint: PATCH /v1/users/me/addresses/\{address_id\}
Parameters
path: paths["/v1/users/me/addresses/{address_id}"]["patch"]["parameters"]["path"]body: paths["/v1/users/me/addresses/{address_id}"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/addresses/{address_id}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/users/me/addresses/{address_id}", {
params: {
path: {
address_id: "<address_id>",
},
},
body: {
/* paths["/v1/users/me/addresses/{address_id}"]["patch"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/users/me/addresses/{address_id}/set-default
Underlying REST endpoint: POST /v1/users/me/addresses/\{address_id\}/set-default
Parameters
path: paths["/v1/users/me/addresses/{address_id}/set-default"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/users/me/addresses/{address_id}/set-default"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/addresses/{address_id}/set-default", {
params: {
path: {
address_id: "<address_id>",
},
},
});POST /v1/users/me/avatar
Underlying REST endpoint: POST /v1/users/me/avatar
Parameters
body: paths["/v1/users/me/avatar"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/avatar"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/avatar", {
body: {
/* paths["/v1/users/me/avatar"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/users/me/backup-codes
Underlying REST endpoint: GET /v1/users/me/backup-codes
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/backup-codes"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me/backup-codes");POST /v1/users/me/backup-codes/regenerate
Underlying REST endpoint: POST /v1/users/me/backup-codes/regenerate
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/backup-codes/regenerate"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/backup-codes/regenerate");GET /v1/users/me/connected-apps
Underlying REST endpoint: GET /v1/users/me/connected-apps
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/connected-apps"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me/connected-apps");DELETE /v1/users/me/connected-apps/{client_id}
Underlying REST endpoint: DELETE /v1/users/me/connected-apps/\{client_id\}
Parameters
path: paths["/v1/users/me/connected-apps/{client_id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: void;
error?: unknown;
response: Response;
}>Example
const result = await identity.DELETE("/v1/users/me/connected-apps/{client_id}", {
params: {
path: {
client_id: "<client_id>",
},
},
});POST /v1/users/me/email-change-confirm
Underlying REST endpoint: POST /v1/users/me/email-change-confirm
Parameters
body: paths["/v1/users/me/email-change-confirm"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/email-change-confirm"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/email-change-confirm", {
body: {
/* paths["/v1/users/me/email-change-confirm"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/users/me/email-change-request
Underlying REST endpoint: POST /v1/users/me/email-change-request
Parameters
body: paths["/v1/users/me/email-change-request"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/email-change-request"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/email-change-request", {
body: {
/* paths["/v1/users/me/email-change-request"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/users/me/mfa
Underlying REST endpoint: GET /v1/users/me/mfa
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/mfa"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me/mfa");DELETE /v1/users/me/mfa/{method_id}
Underlying REST endpoint: DELETE /v1/users/me/mfa/\{method_id\}
Parameters
path: paths["/v1/users/me/mfa/{method_id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/users/me/mfa/{method_id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.DELETE("/v1/users/me/mfa/{method_id}", {
params: {
path: {
method_id: "<method_id>",
},
},
});POST /v1/users/me/mfa/totp/confirm
Underlying REST endpoint: POST /v1/users/me/mfa/totp/confirm
Parameters
body: paths["/v1/users/me/mfa/totp/confirm"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/mfa/totp/confirm"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/mfa/totp/confirm", {
body: {
/* paths["/v1/users/me/mfa/totp/confirm"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/users/me/mfa/totp/init
Underlying REST endpoint: POST /v1/users/me/mfa/totp/init
Parameters
body?: paths["/v1/users/me/mfa/totp/init"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/mfa/totp/init"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/mfa/totp/init", {
body: {
/* paths["/v1/users/me/mfa/totp/init"]["post"]["requestBody"]["content"]["application/json"] */
},
});PATCH /v1/users/me/profile
Underlying REST endpoint: PATCH /v1/users/me/profile
Parameters
body: paths["/v1/users/me/profile"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/profile"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/users/me/profile", {
body: {
/* paths["/v1/users/me/profile"]["patch"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/users/me/sessions
Underlying REST endpoint: GET /v1/users/me/sessions
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/sessions"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me/sessions");POST /v1/users/me/sessions/sign-out-others
Underlying REST endpoint: POST /v1/users/me/sessions/sign-out-others
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/sessions/sign-out-others"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/users/me/sessions/sign-out-others");GET /v1/users/me/settings
Underlying REST endpoint: GET /v1/users/me/settings
Parameters
None
Return type
Promise<{
data?: paths["/v1/users/me/settings"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.GET("/v1/users/me/settings");PATCH /v1/users/me/settings
Underlying REST endpoint: PATCH /v1/users/me/settings
Parameters
body: paths["/v1/users/me/settings"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/users/me/settings"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.PATCH("/v1/users/me/settings", {
body: {
/* paths["/v1/users/me/settings"]["patch"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/webhooks/workos/auth-emails
Underlying REST endpoint: POST /v1/webhooks/workos/auth-emails
Parameters
body?: paths["/v1/webhooks/workos/auth-emails"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/webhooks/workos/auth-emails"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await identity.POST("/v1/webhooks/workos/auth-emails", {
body: {
/* paths["/v1/webhooks/workos/auth-emails"]["post"]["requestBody"]["content"]["application/json"] */
},
});