diff --git a/api_spec.yaml b/api_spec.yaml index 3a8380c..1730e19 100644 --- a/api_spec.yaml +++ b/api_spec.yaml @@ -3,9 +3,9 @@ info: description: | This is the API exposed by the SuperTokens Core. To be consumed by your backend only. - `appid-` and `` in all the APIs are optional. Their default values are `appid-public` and `public` respectively. + `appid-{appId}` and `{tenantId}` in all the APIs are optional. Their default values are `appid-public` and `public` respectively. - Those that do not have `` in the path will enforce that the API is called from `public` tenant only. + Those that do not have `{tenantId}` in the path will enforce that the API is called from `public` tenant only. version: 5.3.0 title: Core Driver Interface @@ -31,13 +31,16 @@ tags: paths: - /appid-/recipe/accountlinking/user/primary/check: + /appid-{appId}/recipe/accountlinking/user/primary/check: get: tags: - Account Linking Recipe operationId: canCreatePrimaryUser + summary: Check primary user creation possibility description: | Check if primary user can be created for given user id + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/accountLinkingRid' - $ref: '#/components/parameters/api-key' @@ -46,6 +49,7 @@ paths: name: recipeUserId schema: type: string + description: The recipe user ID to check example: fa7a0841-b533-4478-9253-0fde890c576 required: true responses: @@ -56,11 +60,14 @@ paths: schema: oneOf: - type: object + title: Primary User Check Success + description: Response when user can be created as primary properties: status: $ref: '#/components/schemas/statusOK' wasAlreadyAPrimaryUser: type: boolean + description: Indicates if the user was already a primary user example: true - type: object properties: @@ -100,13 +107,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/accountlinking/user/link/check: + /appid-{appId}/recipe/accountlinking/user/link/check: get: tags: - Account Linking Recipe operationId: canLinkAccounts + summary: Check account linking possibility description: | Check if accounts can be linked for given primary and recipe user id + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/accountLinkingRid' - $ref: '#/components/parameters/api-key' @@ -180,13 +190,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/accountlinking/user/primary: + /appid-{appId}/recipe/accountlinking/user/primary: post: tags: - Account Linking Recipe operationId: createPrimaryUser + summary: Create primary user account description: | Create a primary user for given user id + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/accountLinkingRid' - $ref: '#/components/parameters/api-key' @@ -268,13 +281,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/accountlinking/user/link: + /appid-{appId}/recipe/accountlinking/user/link: post: tags: - Account Linking Recipe operationId: linkAccounts + summary: Link user accounts together description: | Link accounts for given primary and recipe user id + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/accountLinkingRid' - $ref: '#/components/parameters/api-key' @@ -358,13 +374,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/accountlinking/user/unlink: + /appid-{appId}/recipe/accountlinking/user/unlink: post: tags: - Account Linking Recipe operationId: unlinkAccounts + summary: Unlink user accounts description: | Unlink accounts for given recipe user id + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/accountLinkingRid' - $ref: '#/components/parameters/api-key' @@ -409,13 +428,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/totp/device: + /appid-{appId}/recipe/totp/device: post: tags: - Totp Recipe operationId: createTotpDevice + summary: Add TOTP device for user description: | Add a TOTP device for a user and enable TOTP if not already enabled. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -482,8 +504,11 @@ paths: tags: - Totp Recipe operationId: updateTotpDeviceName + summary: Update TOTP device name description: | Update the name of a TOTP device for a user. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -541,13 +566,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/totp/device/list: + /appid-{appId}/recipe/totp/device/list: get: tags: - Totp Recipe operationId: getTotpDevices + summary: List user TOTP devices description: | Retrieve a list of TOTP devices for a user. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -606,8 +634,11 @@ paths: tags: - Totp Recipe operationId: importTotpDevice + summary: Import existing TOTP device description: | Add a TOTP device for a user and enable TOTP if not already enabled. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -671,13 +702,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/totp/device/remove: + /appid-{appId}/recipe/totp/device/remove: post: tags: - Totp Recipe operationId: removeTotpDevice + summary: Remove TOTP device description: | Remove a TOTP device for a user. If all devices are removed, TOTP is disabled for the user. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -724,13 +758,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/totp/verify: + /appid-{appId}/{tenantId}/recipe/totp/verify: post: tags: - Totp Recipe operationId: verifyTotpCode + summary: Verify TOTP code description: | Check if a TOTP code is valid against any of the TOTP devices for a user. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -811,13 +848,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/totp/device/verify: + /appid-{appId}/{tenantId}/recipe/totp/device/verify: post: tags: - Totp Recipe operationId: verifyTotpDevice + summary: Verify TOTP device description: | Mark a TOTP device as verified if the given TOTP code is valid for that device. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/totpRid' - $ref: '#/components/parameters/api-key' @@ -902,13 +942,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/userid/map: + /appid-{appId}/recipe/userid/map: post: tags: - UserIdMapping Recipe operationId: userIdMappingCreateMapping + summary: Create user ID mapping description: | Create a mapping between a SuperTokens userId and an external userId. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userIdMappingRid' - $ref: '#/components/parameters/api-key' @@ -977,8 +1020,11 @@ paths: tags: - UserIdMapping Recipe operationId: userIdMappingGetMapping + summary: Get user ID mapping description: | Retrieve a UserIdMapping + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userIdMappingRid' - $ref: '#/components/parameters/api-key' @@ -1035,13 +1081,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/userid/map/remove: + /appid-{appId}/recipe/userid/map/remove: post: tags: - UserIdMapping Recipe operationId: userIdMappingRemoveMapping + summary: Remove user ID mapping description: | Delete a mapping between a SuperTokens userId and an external userId. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userIdMappingRid' - $ref: '#/components/parameters/api-key' @@ -1088,13 +1137,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/userid/external-user-id-info: + /appid-{appId}/recipe/userid/external-user-id-info: put: tags: - UserIdMapping Recipe operationId: userIdMappingUpateExternalUserIdInfo + summary: Update external user info description: | Update or delete externalUserIdInfo + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userIdMappingRid' - $ref: '#/components/parameters/api-key' @@ -1147,13 +1199,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup/code/check: + /appid-{appId}/{tenantId}/recipe/signinup/code/check: post: tags: - Passwordless Recipe operationId: passwordlessCheckCode + summary: Check passwordless code description: | Tries to check if the passed userInputCode+deviceId combo or the linkCode is valid + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1240,13 +1295,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup/code/consume: + /appid-{appId}/{tenantId}/recipe/signinup/code/consume: post: tags: - Passwordless Recipe operationId: passwordlessTryUseCode + summary: Consume passwordless code description: | Tries to consume the passed userInputCode+deviceId combo or the linkCode to sign the user in + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1340,14 +1398,17 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup/code: + /appid-{appId}/{tenantId}/recipe/signinup/code: post: tags: - Passwordless Recipe operationId: passwordlessStartSignIn + summary: Start passwordless sign in description: | Starts a sign in process by requesting a linkCode and a deviceId + userInputCode combination the user can use to sign in. Passing the optional deviceId signifies a resend code flow. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1428,13 +1489,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup/code/remove: + /appid-{appId}/{tenantId}/recipe/signinup/code/remove: post: tags: - Passwordless Recipe operationId: passwordlessRevokeCode + summary: Revoke passwordless code description: | Revokes a code by id + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1479,13 +1543,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup/codes: + /appid-{appId}/{tenantId}/recipe/signinup/codes: get: tags: - Passwordless Recipe operationId: passwordlessListCodes + summary: List passwordless codes description: | Lists all active passwordless codes of the user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1566,13 +1633,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup/codes/remove: + /appid-{appId}/{tenantId}/recipe/signinup/codes/remove: post: tags: - Passwordless Recipe operationId: passwordlessRevokeAllCodesOfUser + summary: Revoke all user codes description: | Revokes all codes issued for the user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1617,11 +1687,12 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user⠀⠀: + /appid-{appId}/{tenantId}/recipe/user⠀⠀: get: tags: - Passwordless Recipe operationId: passwordlessGetUser + summary: Get passwordless user deprecated: true description: | Get a user's information. @@ -1631,6 +1702,8 @@ paths: Note that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1680,9 +1753,12 @@ paths: tags: - Passwordless Recipe operationId: passwordlessPutUser + summary: Update passwordless user description: | Update a user's information. If the email or phoneNumber is set to null the previous value will be deleted. If they are not set (i.e., undefined/missing from the request), they are left as-is. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/passwordlessRid' - $ref: '#/components/parameters/api-key' @@ -1737,13 +1813,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signin: + /appid-{appId}/{tenantId}/recipe/signin: post: tags: - EmailPassword Recipe operationId: emailPasswordSignin + summary: Sign in user description: | Signin a user with email ID and password + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -1788,13 +1867,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signup: + /appid-{appId}/{tenantId}/recipe/signup: post: tags: - EmailPassword Recipe operationId: emailPasswordSignup + summary: Sign up user description: | Signup a user with email ID and password + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -1842,11 +1924,12 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/user: + /appid-{appId}/recipe/user: get: tags: - EmailPassword Recipe operationId: emailPasswordGetUser + summary: Get email password user deprecated: true description: | Get a user's information @@ -1854,6 +1937,8 @@ paths: API is tenant specific if querying by email. If querying by userId, tenantId will be ignored. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -1903,8 +1988,11 @@ paths: tags: - EmailPassword Recipe operationId: emailPasswordPutUser + summary: Update user info description: | Update a user's information + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -1953,13 +2041,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/password/reset/token: + /appid-{appId}/{tenantId}/recipe/user/password/reset/token: post: tags: - EmailPassword Recipe operationId: emailPasswordGetPasswordResetToken + summary: Generate password reset token description: | Generate a new reset password token for this user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -2004,14 +2095,17 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/password/reset: + /appid-{appId}/{tenantId}/recipe/user/password/reset: post: tags: - EmailPassword Recipe operationId: emailPasswordGetPasswordReset + summary: Reset user password deprecated: true description: | Reset a password using password reset token + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -2062,13 +2156,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/passwordhash/import: + /appid-{appId}/{tenantId}/recipe/user/passwordhash/import: post: tags: - EmailPassword Recipe operationId: userImport + summary: Import user with hash description: | Import a user with email ID and password hash + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -2113,13 +2210,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/password/reset/token/consume: + /appid-{appId}/{tenantId}/recipe/user/password/reset/token/consume: post: tags: - EmailPassword Recipe operationId: emailPasswordResetPasswordConsumeToken + summary: Consume password reset token description: | Consume a password reset token + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/rid' - $ref: '#/components/parameters/api-key' @@ -2164,13 +2264,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/signinup: + /appid-{appId}/{tenantId}/recipe/signinup: post: tags: - ThirdParty Recipe operationId: thirdPartySigninup + summary: Sign in/up third party user description: | Signin/up a user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/thirdPartyRid' - $ref: '#/components/parameters/api-key' @@ -2225,12 +2328,15 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user⠀: + /appid-{appId}/{tenantId}/recipe/user⠀: get: tags: - ThirdParty Recipe operationId: thirdPartyGetUser + summary: Get a user's information (deprecated) deprecated: true + security: + - ApiKey: [] description: | Get a user's information. @@ -2285,15 +2391,18 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/users/by-email: + /appid-{appId}/{tenantId}/recipe/users/by-email: get: operationId: thirdPartyGetUsersByEmail + summary: Get users by email deprecated: true tags: - ThirdParty Recipe description: | Get all users accounts associated with given email + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/thirdPartyRid' - $ref: '#/components/parameters/api-key' @@ -2331,13 +2440,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/email/verify/token: + /appid-{appId}/{tenantId}/recipe/user/email/verify/token: post: tags: - EmailVerification Recipe operationId: emailVerificationVerifyToken + summary: Generate email verification token description: | Generate a new email verification token for this user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/emailVerificationRid' - $ref: '#/components/parameters/api-key' @@ -2378,13 +2490,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/email/verify/token/remove: + /appid-{appId}/{tenantId}/recipe/user/email/verify/token/remove: post: tags: - EmailVerification Recipe operationId: emailVerificationVerifyTokenRemove + summary: Remove email verification tokens description: | Remove all unused email verification tokens for this user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/emailVerificationRid' - $ref: '#/components/parameters/api-key' @@ -2417,13 +2532,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/email/verify: + /appid-{appId}/{tenantId}/recipe/user/email/verify: post: tags: - EmailVerification Recipe operationId: emailVerificationVerify + summary: Verify email description: | Verify an email + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/emailVerificationRid' - $ref: '#/components/parameters/api-key' @@ -2474,13 +2592,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/user/email/verify: + /appid-{appId}/recipe/user/email/verify: get: tags: - EmailVerification Recipe operationId: emailVerificationVerifyGet + summary: Check email verification description: | Check if an email is verified + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/emailVerificationRid' - $ref: '#/components/parameters/api-key' @@ -2512,13 +2633,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/user/email/verify/remove: + /appid-{appId}/recipe/user/email/verify/remove: post: tags: - EmailVerification Recipe operationId: emailVerificationVerifyRemove + summary: Unverify email description: | Unverify an email + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/emailVerificationRid' - $ref: '#/components/parameters/api-key' @@ -2552,13 +2676,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/user/metadata: + /appid-{appId}/recipe/user/metadata: get: tags: - User Metadata Recipe operationId: userMetadataRead + summary: Get user metadata description: | Gets the stored metadata object of the user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userMetadataRid' - $ref: '#/components/parameters/api-key' @@ -2592,6 +2719,7 @@ paths: tags: - User Metadata Recipe operationId: userMetadataUpdate + summary: Update user metadata description: | Updates the metadata object stored about the user by doing a shallow merge of the stored and the update JSONs and removing properties set to null on the root level of the update object. The merged object is then reserialized and stored. @@ -2603,6 +2731,8 @@ paths: - result: `{ "preferences": { "theme":"dark" }, "notifications": { "sms": true } }` + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userMetadataRid' - $ref: '#/components/parameters/api-key' @@ -2641,14 +2771,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/user/metadata/remove: + /appid-{appId}/recipe/user/metadata/remove: post: tags: - User Metadata Recipe operationId: userMetadataDelete + summary: Remove user metadata description: | Removes the entire metadata JSON stored about the user. - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userMetadataRid' - $ref: '#/components/parameters/api-key' @@ -2685,14 +2817,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/role: + /appid-{appId}/{tenantId}/recipe/user/role: put: tags: - User Roles Recipe operationId: addUserRole + summary: Add user role description: | Creates a User Role mapping - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -2737,14 +2871,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/role/remove: + /appid-{appId}/{tenantId}/recipe/user/role/remove: post: tags: - User Roles Recipe operationId: removeUserRole + summary: Remove user role description: | Removes a User Role mapping - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -2789,13 +2925,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/user/roles: + /appid-{appId}/{tenantId}/recipe/user/roles: get: tags: - User Roles Recipe operationId: getUserRoles + summary: Get user roles description: | Retrive the roles associated with the user. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -2827,13 +2966,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/role/users: + /appid-{appId}/{tenantId}/recipe/role/users: get: tags: - User Roles Recipe operationId: getRoleUsers + summary: Get role users description: | Retrive the users associated with the role. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -2868,14 +3010,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/role: + /appid-{appId}/recipe/role: put: tags: - User Roles Recipe operationId: putRole + summary: Create or update role description: | Creates a role with permissions, can also be used to add permissions to a role - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -2922,13 +3066,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/role/permissions: + /appid-{appId}/recipe/role/permissions: get: tags: - User Roles Recipe operationId: getRolePermissions + summary: Get role permissions description: | Retrive the permissions associated with a role + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -2964,14 +3111,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/role/permissions/remove: + /appid-{appId}/recipe/role/permissions/remove: post: tags: - User Roles Recipe operationId: removeRolePermissions + summary: Remove role permissions description: | Removes permissions mapped to a role, if no permissions are passed all permissions mapped to the role are removed - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -3016,13 +3165,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/permission/roles: + /appid-{appId}/recipe/permission/roles: get: tags: - User Roles Recipe operationId: getPermissionRoles + summary: Get permission roles description: | Retrive the roles associated with the permission + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -3056,14 +3208,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/role/remove: + /appid-{appId}/recipe/role/remove: post: tags: - User Roles Recipe operationId: removeRole + summary: Delete role description: | Deletes a role - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -3104,13 +3258,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/roles: + /appid-{appId}/recipe/roles: get: tags: - User Roles Recipe operationId: getRoles + summary: Get all roles description: | Retrive all created roles + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/userRolesRid' - $ref: '#/components/parameters/api-key' @@ -3143,13 +3300,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/session: + /appid-{appId}/{tenantId}/recipe/session: post: tags: - Session Recipe operationId: createNewSession + summary: Create new session description: | Create a new Session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3203,13 +3363,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/session: + /appid-{appId}/recipe/session: get: tags: - Session Recipe operationId: getSessionInfo + summary: Get session info description: | Get user and session information for a given session handle + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3259,18 +3422,20 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/session/remove: + /appid-{appId}/{tenantId}/recipe/session/remove: post: tags: - Session Recipe operationId: deleteSession + summary: Delete session description: | Delete a sesion If revoking session by `userId`, the sessions are cleared across all tenants by default. Note: If `revokeAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant. - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3317,18 +3482,20 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/session/remove: + /appid-{appId}/recipe/session/remove: post: tags: - Session Recipe operationId: deleteSession + summary: Delete session description: | Delete a sesion If revoking session by `userId`, the sessions are cleared across all tenants by default. Note: If `revokeAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant. - + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3377,13 +3544,16 @@ paths: $ref: '#/components/responses/500' - /appid-/recipe/session/verify: + /appid-{appId}/recipe/session/verify: post: tags: - Session Recipe operationId: verifySession + summary: Verify session description: | Verify a Session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3442,13 +3612,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/session/refresh: + /appid-{appId}/recipe/session/refresh: post: tags: - Session Recipe operationId: refreshSession + summary: Refresh session description: | Refresh a Session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3518,17 +3691,20 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/session/user: + /appid-{appId}/{tenantId}/recipe/session/user: get: tags: - Session Recipe operationId: getUserSessionHandles + summary: Get user session handles description: | Get session handles for a user By default, the session handles are fetched across all tenants. Set `fetchAcrossAllTenants` to `false` to get sessionHandles for the user for a particular tenant. Note: If `fetchAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3565,17 +3741,20 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/session/user: + /appid-{appId}/recipe/session/user: get: tags: - Session Recipe operationId: getUserSessionHandles + summary: Get user session handles description: | Get session handles for a user By default, the session handles are fetched across all tenants. Set `fetchAcrossAllTenants` to `false` to get sessionHandles for the user for a particular tenant. Note: If `fetchAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3613,13 +3792,16 @@ paths: $ref: '#/components/responses/500' - /appid-/recipe/session/regenerate: + /appid-{appId}/recipe/session/regenerate: post: tags: - Session Recipe operationId: regenerateSession + summary: Regenerate session description: | Regenerate a session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3663,14 +3845,17 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/session/data: + /appid-{appId}/recipe/session/data: get: deprecated: true tags: - Session Recipe operationId: getSessionData + summary: Get session data description: | Get session data + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3711,8 +3896,11 @@ paths: tags: - Session Recipe operationId: putSessionData + summary: Change session data description: | Change session data + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3749,13 +3937,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/jwt: + /appid-{appId}/recipe/jwt: post: tags: - JWT Recipe operationId: createSignedJWT + summary: Create a signed JWT description: | Create a signed JWT + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/jwtRID' - $ref: '#/components/parameters/api-key' @@ -3808,7 +3999,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/jwt/jwks: + /appid-{appId}/recipe/jwt/jwks: get: deprecated: true tags: @@ -3844,7 +4035,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/.well-known/jwks.json: + /appid-{appId}/.well-known/jwks.json: get: tags: - Core @@ -3875,14 +4066,17 @@ paths: $ref: '#/components/responses/500' - /appid-/recipe/jwt/data: + /appid-{appId}/recipe/jwt/data: get: deprecated: true tags: - Session Recipe operationId: getJWTData + summary: Get JWT data for a session description: | Get JWT data for a session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3923,8 +4117,11 @@ paths: tags: - Session Recipe operationId: putJWTData + summary: Change JWT data for a session description: | Change JWT data for a session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/sessionRid' - $ref: '#/components/parameters/api-key' @@ -3961,13 +4158,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/dashboard/user: + /appid-{appId}/recipe/dashboard/user: post: tags: - Dashboard Recipe operationId: createDashboardUser + summary: Create a dashboard user description: | Create a dashboard user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4056,8 +4256,11 @@ paths: tags: - Dashboard Recipe operationId: updateDashboardUser + summary: Update a user's email or password description: | Update a user's email or password + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4153,8 +4356,11 @@ paths: tags: - Dashboard Recipe operationId: deleteDashboardUser + summary: Delete a dashboard user with their userId or email description: | Delete a dashboard user with their userId or email + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4198,13 +4404,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/dashboard/users: + /appid-{appId}/recipe/dashboard/users: get: tags: - Dashboard Recipe operationId: getAllDashboardUsers + summary: Get a list of all the dashboard users description: | - Get a list of call the dashboard users + Get a list of all the dashboard users + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4250,13 +4459,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/dashboard/session/verify: + /appid-{appId}/recipe/dashboard/session/verify: post: tags: - Dashboard Recipe operationId: verifyDashboardUserSession + summary: Verify a Dashboard user's sessionId description: | Verify a Dashboard user's sessionId + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4309,13 +4521,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/dashboard/session: + /appid-{appId}/recipe/dashboard/session: delete: tags: - Dashboard Recipe operationId: RevokeDashboardUsersSession + summary: Revoke a Dashboard user's session description: | Revoke a Dashboard user's session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4348,13 +4563,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/dashboard/signin: + /appid-{appId}/recipe/dashboard/signin: post: tags: - Dashboard Recipe operationId: signInDashboardUser + summary: Sign in a Dashboard user description: | - Signin a Dashboard user + Sign in a Dashboard user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4411,13 +4629,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/dashboard/user/sessions: + /appid-{appId}/recipe/dashboard/user/sessions: get: tags: - Dashboard Recipe operationId: getAllSessionsForDashboardUser + summary: Get a list of the sessions for the dashboard user description: | Get a list of the sessions for the dashboard user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/dashboardRid' - $ref: '#/components/parameters/api-key' @@ -4465,13 +4686,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/apiversion: + /appid-{appId}/apiversion: get: tags: - Core operationId: getApiVersion + summary: Get a list of compatible CDI versions description: | Get a list of compatible CDI versions + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - in: query @@ -4517,8 +4741,11 @@ paths: tags: - Core operationId: getConfig + summary: Get path to the loaded config file description: | Get path to the loaded config file + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4560,26 +4787,32 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//: + /appid-{appId}/{tenantId}/: get: tags: - Core operationId: getHelloOnRootPath + summary: Return a simple hello message description: | Return a simple hello message + security: + - ApiKey: [] responses: '200': $ref: '#/components/responses/hello' '500': $ref: '#/components/responses/500' - /appid-//hello: + /appid-{appId}/{tenantId}/hello: get: tags: - Core operationId: getHello + summary: Return a simple hello message description: | Return a simple hello message + security: + - ApiKey: [] responses: '200': $ref: '#/components/responses/hello' @@ -4589,8 +4822,11 @@ paths: tags: - Core operationId: putHello + summary: Return a simple hello message description: | Return a simple hello message + security: + - ApiKey: [] responses: '200': $ref: '#/components/responses/hello' @@ -4601,8 +4837,11 @@ paths: tags: - Core operationId: postHello + summary: Return a simple hello message description: | Return a simple hello message + security: + - ApiKey: [] responses: '200': $ref: '#/components/responses/hello' @@ -4613,21 +4852,27 @@ paths: tags: - Core operationId: deleteHello + summary: Return a simple hello message description: | Return a simple hello message + security: + - ApiKey: [] responses: '200': $ref: '#/components/responses/hello' '500': $ref: '#/components/responses/500' - /appid-/telemetry: + /appid-{appId}/telemetry: get: tags: - Core operationId: getTelemetry + summary: Returns the telemetryID if it exists description: | Returns the telemetryID if it exists + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4669,16 +4914,19 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//users/count: + /appid-{appId}/{tenantId}/users/count: get: tags: - Core operationId: getUsersCount + summary: Get number of users description: | Get number of users. API is tenant specific if `includeAllTenants` is false. Else, `tenantId` is ignored. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' @@ -4716,13 +4964,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/users/count/active: + /appid-{appId}/users/count/active: get: tags: - Core operationId: getActiveUsersCount + summary: Get number of active users description: | Get number of active users. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4758,13 +5009,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//users: + /appid-{appId}/{tenantId}/users: get: tags: - Core operationId: getUsers + summary: User Pagination description: | User Pagination + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4829,13 +5083,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/user/remove: + /appid-{appId}/user/remove: post: tags: - Core operationId: deleteUser + summary: Delete user description: | Delete user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4869,13 +5126,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/user/search/tags: + /appid-{appId}/user/search/tags: get: tags: - Core operationId: getSearchTags + summary: Retrieve available tags for search description: | Retrieve available tags for search + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4908,13 +5168,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/ee/featureflag: + /appid-{appId}/ee/featureflag: get: tags: - Core operationId: getFeatureFlag + summary: Get a list of the enabled enterprise features description: | Get a list of the enabled enterprise features + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -4949,13 +5212,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/ee/license: + /appid-{appId}/ee/license: put: tags: - Core operationId: setLicense + summary: Set or sync license key description: | Set or sync license key + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -5003,8 +5269,11 @@ paths: tags: - Core operationId: deleteLicense + summary: Delete license key description: | Delete license key + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -5031,8 +5300,11 @@ paths: tags: - Core operationId: getLicense + summary: Retrieve license key description: | Retrieve license key + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -5065,13 +5337,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/user/id: + /appid-{appId}/user/id: get: tags: - Core operationId: getUserId + summary: Get user id from email or phone number description: | Get user id from email or phone number + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -5106,13 +5381,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//users/by-accountinfo: + /appid-{appId}/{tenantId}/users/by-accountinfo: get: tags: - Core operationId: getUsersByAccountInfo + summary: Get users by email, phoneNumber or thirdParty info description: | Get users by email, phoneNumber or thirdParty info + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -5172,17 +5450,20 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/requests/stats: + /appid-{appId}/requests/stats: get: tags: - Core operationId: getRequestsStats + summary: Get requests stats for last 24 hours description: | Get requests stats for last 24 hours `averageRequestsPerSecond` and `peakRequestsPerSecond` would countain `1440` values corresponding to `now - 1440 minutes` until `now - 1 minute`. A value of `-1` would mean that there is no data for that minute. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -5253,7 +5534,10 @@ paths: Note: Updation of core config is not allowed for the default connectionUriDomain. In order to update config for the default connectionUriDomain, you must edit the config.yaml or the docker env directly. operationId: createOrUpdateConnectionURIDomainPUT + summary: Create or update a connection uri domain (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5356,6 +5640,9 @@ paths: Note: Updation of core config is not allowed for the default connectionUriDomain. In order to update config for the default connectionUriDomain, you must edit the config.yaml or the docker env directly. operationId: createOrUpdateConnectionURIDomainV2PUT + summary: Create or update a connection uri domain (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5417,6 +5704,9 @@ paths: Note: There should be no apps or tenants (other than the public app and public tenant) belonging to the connection uri domain to be able to delete it. operationId: deleteConnectionUriDomainPOST + summary: Delete connection uri domain + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5476,7 +5766,10 @@ paths: Request must originate from base connection uri domain and public app and tenant. operationId: connectionUriDomainListGET + summary: Get a list of all connection uri domains (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5543,6 +5836,9 @@ paths: Request must originate from base connection uri domain and public app and tenant. operationId: connectionUriDomainListV2GET + summary: Get a list of all connection uri domains (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5624,7 +5920,10 @@ paths: Note: Updation of core config is not allowed for the default connectionUriDomain, public app. In order to update config for the default connectionUriDomain and public app, you must edit the config.yaml or the docker env directly. operationId: createOrUpdateAppPUT + summary: Create or update an app (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5725,6 +6024,9 @@ paths: Note: Updation of core config is not allowed for the default connectionUriDomain, public app. In order to update config for the default connectionUriDomain and public app, you must edit the config.yaml or the docker env directly. operationId: createOrUpdateAppV2PUT + summary: Create or update an app (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5784,6 +6086,9 @@ paths: Note: No tenants (other than the public tenant) must belong to the app to be able to delete it. operationId: deleteAppPOST + summary: Delete an app + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5843,7 +6148,10 @@ paths: Request must originate from public app and tenant. operationId: appListGET + summary: Get a list of all apps in a connection uri domain (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5901,6 +6209,9 @@ paths: Request must originate from public app and tenant. operationId: appListV2GET + summary: Get a list of all apps in a connection uri domain (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -5943,7 +6254,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/multitenancy/tenant: + /appid-{appId}/recipe/multitenancy/tenant: put: tags: - Multitenancy Recipe @@ -5971,7 +6282,10 @@ paths: Note: Updation of core config is not allowed for the default connectionUriDomain, public app and tenant. In order to update config for the default connectionUriDomain, public app and tenant, you must edit the config.yaml or the docker env directly. operationId: createOrUpdateTenantPUT + summary: Create or update a tenant (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6018,7 +6332,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/multitenancy/tenant/v2: + /appid-{appId}/recipe/multitenancy/tenant/v2: put: tags: - Multitenancy Recipe @@ -6069,6 +6383,9 @@ paths: Note: Updation of core config is not allowed for the default connectionUriDomain, public app and tenant. In order to update config for the default connectionUriDomain, public app and tenant, you must edit the config.yaml or the docker env directly. operationId: createOrUpdateTenantV2PUT + summary: Create or update a tenant (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6115,7 +6432,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/multitenancy/tenant: + /appid-{appId}/{tenantId}/recipe/multitenancy/tenant: get: tags: - Multitenancy Recipe @@ -6131,7 +6448,10 @@ paths: Returns recipes with their enabled flag and recipe specific configs saved in core operationId: tenantConfigGet + summary: Get tenant config (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6169,7 +6489,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/multitenancy/tenant/v2: + /appid-{appId}/{tenantId}/recipe/multitenancy/tenant/v2: get: tags: - Multitenancy Recipe @@ -6186,6 +6506,9 @@ paths: Returns recipes with their enabled flag and recipe specific configs saved in core operationId: tenantConfigV2Get + summary: Get tenant config (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6223,7 +6546,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/dashboard/tenant/core-config: + /appid-{appId}/{tenantId}/recipe/dashboard/tenant/core-config: get: tags: - Dashboard Recipe @@ -6231,6 +6554,9 @@ paths: Get the core config of the tenant specified by the url prefix, along with the metadata of each of the fields. operationId: tenantCoreConfigForDashboardGET + summary: Get tenant core config for dashboard + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6310,7 +6636,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/multitenancy/tenant/remove: + /appid-{appId}/recipe/multitenancy/tenant/remove: post: tags: - Multitenancy Recipe @@ -6320,6 +6646,9 @@ paths: Request must originate from public tenant. operationId: deleteTenantPOST + summary: Delete a tenant + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6364,7 +6693,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/multitenancy/tenant/list: + /appid-{appId}/recipe/multitenancy/tenant/list: get: tags: - Multitenancy Recipe @@ -6378,7 +6707,10 @@ paths: Request must originate from public tenant. operationId: tenantListGET + summary: Get list of all tenants (deprecated) deprecated: true + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6413,7 +6745,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/multitenancy/tenant/list/v2: + /appid-{appId}/recipe/multitenancy/tenant/list/v2: get: tags: - Multitenancy Recipe @@ -6428,6 +6760,9 @@ paths: Request must originate from public tenant. operationId: tenantListV2GET + summary: Get list of all tenants (v2) + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6462,7 +6797,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/multitenancy/config/thirdparty: + /appid-{appId}/{tenantId}/recipe/multitenancy/config/thirdparty: put: tags: - Multitenancy Recipe @@ -6508,6 +6843,9 @@ paths: - `additionalConfig` in the each element must contain `boxyURL` and must be non-empty string operationId: createOrUpdateTenantConfigPUT + summary: Creates or updates ThirdParty Provider Config for a tenant + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6558,7 +6896,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/multitenancy/config/thirdparty/remove: + /appid-{appId}/{tenantId}/recipe/multitenancy/config/thirdparty/remove: post: tags: - Multitenancy Recipe @@ -6566,6 +6904,9 @@ paths: Delete ThirdParty Provider config for a tenant. operationId: deleteTenantConfigPOST + summary: Delete ThirdParty Provider config for a tenant + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6609,7 +6950,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/multitenancy/tenant/user: + /appid-{appId}/{tenantId}/recipe/multitenancy/tenant/user: post: tags: - Multitenancy Recipe @@ -6622,6 +6963,9 @@ paths: and user must already exist in the app operationId: addUserToTenant + summary: Add user's association with the tenant + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6682,7 +7026,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/multitenancy/tenant/user/remove: + /appid-{appId}/{tenantId}/recipe/multitenancy/tenant/user/remove: post: tags: - Multitenancy Recipe @@ -6692,6 +7036,9 @@ paths: User will be removed from the tenant based on the url prefix of the request. operationId: removeUserFromTenant + summary: Remove user's association with the tenant + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/multitenancyRid' - $ref: '#/components/parameters/api-key' @@ -6738,13 +7085,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/clients: + /appid-{appId}/recipe/oauth/clients: get: tags: - OAuth2Provider Recipe + operationId: getOAuth2Client + summary: Get OAuth2 Client description: | Get OAuth2 Client - operationId: getOAuth2Client + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -6791,9 +7141,12 @@ paths: post: tags: - OAuth2Provider Recipe + operationId: createOAuth2Client + summary: Create OAuth2 Client description: | Create OAuth2 Client - operationId: createOAuth2Client + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -6834,9 +7187,12 @@ paths: put: tags: - OAuth2Provider Recipe + operationId: updateOAuth2Client + summary: Update OAuth2 Client description: | Update OAuth2 Client - operationId: updateOAuth2Client + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -6874,13 +7230,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/clients/list: + /appid-{appId}/recipe/oauth/clients/list: get: tags: - OAuth2Provider Recipe + operationId: listOAuth2Clients + summary: List OAuth2 Clients description: | List OAuth2 Clients - operationId: listOAuth2Clients + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -6935,13 +7294,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/clients/remove: + /appid-{appId}/recipe/oauth/clients/remove: post: tags: - OAuth2Provider Recipe + operationId: removeOAuth2Client + summary: Remove OAuth2 Client description: | Remove OAuth2 Client - operationId: removeOAuth2Client + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -6984,13 +7346,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/consent: + /appid-{appId}/recipe/oauth/auth/requests/consent: get: tags: - OAuth2Provider Recipe + operationId: getOAuth2ConsentRequest + summary: Get OAuth2 Consent Request description: | Get OAuth2 Consent Request - operationId: getOAuth2ConsentRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7144,13 +7509,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/consent/accept: + /appid-{appId}/recipe/oauth/auth/requests/consent/accept: put: tags: - OAuth2Provider Recipe + operationId: acceptOAuth2ConsentRequest + summary: Accept OAuth2 Consent Request description: | Accept OAuth2 Consent Request - operationId: acceptOAuth2ConsentRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7236,13 +7604,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/consent/reject: + /appid-{appId}/recipe/oauth/auth/requests/consent/reject: put: tags: - OAuth2Provider Recipe + operationId: rejectOAuth2ConsentRequest + summary: Reject OAuth2 Consent Request description: | Reject OAuth2 Consent Request - operationId: rejectOAuth2ConsentRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7300,13 +7671,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/login: + /appid-{appId}/recipe/oauth/auth/requests/login: get: tags: - OAuth2Provider Recipe + operationId: getOAuth2LoginRequest + summary: Get OAuth2 Login Request description: | Get OAuth2 Login Request - operationId: getOAuth2LoginRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7398,13 +7772,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/login/accept: + /appid-{appId}/recipe/oauth/auth/requests/login/accept: put: tags: - OAuth2Provider Recipe + operationId: acceptOAuth2LoginRequest + summary: Accept OAuth2 Login Request description: | Accept OAuth2 Login Request - operationId: acceptOAuth2LoginRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7477,13 +7854,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/login/reject: + /appid-{appId}/recipe/oauth/auth/requests/login/reject: put: tags: - OAuth2Provider Recipe + operationId: rejectOAuth2LoginRequest + summary: Reject OAuth2 Login Request description: | Reject OAuth2 Login Request - operationId: rejectOAuth2LoginRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7540,13 +7920,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/logout/accept: + /appid-{appId}/recipe/oauth/auth/requests/logout/accept: put: tags: - OAuth2Provider Recipe + operationId: acceptOAuth2LogoutRequest + summary: Accept OAuth2 Logout Request description: | Accept OAuth2 Logout Request - operationId: acceptOAuth2LogoutRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7588,13 +7971,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth/requests/logout/reject: + /appid-{appId}/recipe/oauth/auth/requests/logout/reject: put: tags: - OAuth2Provider Recipe + operationId: rejectOAuth2LogoutRequest + summary: Reject OAuth2 Logout Request description: | Reject OAuth2 Logout Request - operationId: rejectOAuth2LogoutRequest + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7633,13 +8019,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/session/revoke: + /appid-{appId}/recipe/oauth/session/revoke: post: tags: - OAuth2Provider Recipe + operationId: revokeOAuth2Session + summary: Revoke OAuth2 Session description: | Revoke OAuth2 Session - operationId: revokeOAuth2Session + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7681,13 +8070,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/token/revoke: + /appid-{appId}/recipe/oauth/token/revoke: post: tags: - OAuth2Provider Recipe + operationId: revokeOAuth2Token + summary: Revoke OAuth2 Token description: | Revoke OAuth2 Token - operationId: revokeOAuth2Token + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7729,13 +8121,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/tokens/revoke: + /appid-{appId}/recipe/oauth/tokens/revoke: post: tags: - OAuth2Provider Recipe - description: | - Revoke OAuth2 Token operationId: revokeOAuth2Tokens + summary: Revoke OAuth2 Tokens + description: | + Revoke OAuth2 Tokens + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7778,13 +8173,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/auth: + /appid-{appId}/recipe/oauth/auth: get: tags: - OAuth2Provider Recipe + operationId: getOAuth2Auth + summary: Get OAuth2 Auth description: | Get OAuth2 Auth - operationId: getOAuth2Auth + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7817,9 +8215,12 @@ paths: post: tags: - OAuth2Provider Recipe + operationId: postOAuth2Auth + summary: Exchange OAuth2 Auth request for redirect or error description: | Exchange OAuth2 Auth request for redirect or error. - operationId: postOAuth2Auth + security: + - ApiKey: [] requestBody: required: true content: @@ -7883,13 +8284,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/token: + /appid-{appId}/recipe/oauth/token: post: tags: - OAuth2Provider Recipe + operationId: getOAuth2Token + summary: Get OAuth2 Token description: | Get OAuth2 Token - operationId: getOAuth2Token + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -7964,13 +8368,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/sessions/logout: + /appid-{appId}/recipe/oauth/sessions/logout: get: tags: - OAuth2Provider Recipe + operationId: getOAuth2SessionsLogout + summary: Get OAuth2 Sessions Logout description: | Get OAuth2 Sessions Logout - operationId: getOAuth2SessionsLogout + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -8025,13 +8432,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/oauth/introspect: + /appid-{appId}/recipe/oauth/introspect: post: tags: - OAuth2Provider Recipe + operationId: introspectOAuth2Token + summary: Introspect OAuth2 Token description: | Introspect OAuth2 Token - operationId: introspectOAuth2Token + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/oauthRid' - $ref: '#/components/parameters/api-key' @@ -8124,13 +8534,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/bulk-import/users: + /appid-{appId}/bulk-import/users: get: tags: - Bulk Import operationId: getBulkImportUsers + summary: Paginated API to get bulk import users description: | Paginated API to get bulk import users + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -8170,8 +8583,11 @@ paths: tags: - Bulk Import operationId: addBulkImportUsers + summary: Add users for bulk import description: | Add users for bulk import. Maximum 10000 users can be added in one request. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -8234,13 +8650,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/bulk-import/users/remove: + /appid-{appId}/bulk-import/users/remove: post: tags: - Bulk Import operationId: deleteBulkImportUsers + summary: Delete bulk import users by id description: | Delete bulk import users by id. Multiple ids can be passed in the request body. + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/api-key' - $ref: '#/components/parameters/cdi-version' @@ -8289,7 +8708,7 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/webauthn/user/credential: + /appid-{appId}/recipe/webauthn/user/credential: get: tags: - WebAuthn Recipe @@ -8297,6 +8716,9 @@ paths: Get the WebAuthn credential for the user. operationId: getWebAuthNCredential + summary: Get the WebAuthn credential for the user + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8353,13 +8775,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/webauthn/user/credential/list: + /appid-{appId}/recipe/webauthn/user/credential/list: get: tags: - WebAuthn Recipe + operationId: listWebAuthNCredentials + summary: List credentials that were created by the user description: List credentials that were created by the user. - operationId: listWebAuthNCredentials + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8417,13 +8842,16 @@ paths: $ref: '#/components/responses/500' - /appid-//recipe/webauthn/options: + /appid-{appId}/{tenantId}/recipe/webauthn/options: get: tags: - WebAuthn Recipe + operationId: getWebAuthNOptions + summary: Get the WebAuthn options description: Get the WebAuthn options. - operationId: getWebAuthNOptions + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8486,13 +8914,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/user/recover: + /appid-{appId}/{tenantId}/recipe/webauthn/user/recover: get: tags: - WebAuthn Recipe + operationId: recoverWebAuthNUser + summary: Recover the user using the WebAuthn credential description: Recover the user using the WebAuthn credential. - operationId: recoverWebAuthNUser + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8534,13 +8965,16 @@ paths: $ref: '#/components/responses/500' - /appid-//recipe/webauthn/options/register: + /appid-{appId}/{tenantId}/recipe/webauthn/options/register: post: tags: - WebAuthn Recipe + operationId: generateRegistrationOptions + summary: Generate the webauthn options for registration description: Generate the webauthn options for registration. - operationId: generateRegistrationOptions + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8689,13 +9123,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/options/signin: + /appid-{appId}/{tenantId}/recipe/webauthn/options/signin: post: tags: - WebAuthn Recipe + operationId: generateSigninOptions + summary: Generate the webauthn options for signin description: Generate the webauthn options for signin. - operationId: generateSigninOptions + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8777,13 +9214,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/webauthn/user/credential/register: + /appid-{appId}/recipe/webauthn/user/credential/register: post: tags: - WebAuthn Recipe + operationId: registerWebAuthNCredential + summary: Register a new credential for the user description: Register a new credential for the user - operationId: registerWebAuthNCredential + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8850,13 +9290,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/signup: + /appid-{appId}/{tenantId}/recipe/webauthn/signup: post: tags: - WebAuthn Recipe + operationId: signUpWebAuthNUser + summary: Sign up the user using the WebAuthn credential description: Sign up the user using the WebAuthn credential. - operationId: signUpWebAuthNUser + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8921,13 +9364,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/signin: + /appid-{appId}/{tenantId}/recipe/webauthn/signin: post: tags: - WebAuthn Recipe + operationId: signInWebAuthNUser + summary: Sign in the user using the WebAuthn credential description: Sign in the user using the WebAuthn credential. - operationId: signInWebAuthNUser + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -8983,13 +9429,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/user/recover/token: + /appid-{appId}/{tenantId}/recipe/webauthn/user/recover/token: post: tags: - WebAuthn Recipe + operationId: generateTokenForRecovery + summary: Generate a token to recover the user description: Generate a token to recover the user. - operationId: generateTokenForRecovery + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -9035,13 +9484,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/user/recover/token/consume: + /appid-{appId}/{tenantId}/recipe/webauthn/user/recover/token/consume: post: tags: - WebAuthn Recipe + operationId: consumeWebAuthNToken + summary: Consume the token to recover the user description: Consume the token to recover the user. - operationId: consumeWebAuthNToken + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -9086,13 +9538,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/user/email: + /appid-{appId}/{tenantId}/recipe/webauthn/user/email: put: tags: - WebAuthn Recipe + operationId: updateEmail + summary: Update the email of the user description: Update the email of the user. - operationId: updateEmail + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -9135,13 +9590,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-/recipe/webauthn/user/credential/remove: + /appid-{appId}/recipe/webauthn/user/credential/remove: delete: tags: - WebAuthn Recipe + operationId: removeWebAuthNCredential + summary: Remove the WebAuthn credential for the user description: Remove the WebAuthn credential for the user. - operationId: removeWebAuthNCredential + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -9183,13 +9641,16 @@ paths: '500': $ref: '#/components/responses/500' - /appid-//recipe/webauthn/options/remove: + /appid-{appId}/{tenantId}/recipe/webauthn/options/remove: delete: tags: - WebAuthn Recipe + operationId: removeWebAuthNOptions + summary: Remove the WebAuthn options description: Remove the WebAuthn options. - operationId: removeWebAuthNOptions + security: + - ApiKey: [] parameters: - $ref: '#/components/parameters/webauthnRid' - $ref: '#/components/parameters/api-key' @@ -9242,6 +9703,15 @@ components: schema: type: string + tenantId: + name: tenantId + in: path + description: The tenant against which the request is made. If left empty, the default tenant will be used. + required: false + schema: + type: string + example: public + thirdPartyRid: name: rid in: header @@ -10439,3 +10909,11 @@ components: statusCode: type: integer + securitySchemes: + ApiKey: + name: api-key + description: The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header. + type: apiKey + in: header + example: ajs30Nlbs0DjvsdFIne934n8NVee5n +