@zitadel/api 0.1.0-alpha.16 → 0.1.0-alpha.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/endpoints/zitadelNextGen.d.mts +2 -2
- package/dist/generated/endpoints/zitadelNextGen.mjs +328 -251
- package/dist/generated/endpoints/zitadelNextGen.mjs.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.msw.d.mts +30 -26
- package/dist/generated/endpoints/zitadelNextGen.msw.d.mts.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.msw.mjs +325 -469
- package/dist/generated/endpoints/zitadelNextGen.msw.mjs.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.zod.d.mts +480 -286
- package/dist/generated/endpoints/zitadelNextGen.zod.d.mts.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.zod.mjs +470 -325
- package/dist/generated/endpoints/zitadelNextGen.zod.mjs.map +1 -1
- package/dist/generated/model/index.d.mts +2 -2
- package/dist/generated/model/index.mjs +144 -70
- package/dist/generated/model/index.mjs.map +1 -1
- package/dist/{index-oloR8wb4.d.mts → index-D6qIOslB.d.mts} +6221 -3481
- package/dist/index-D6qIOslB.d.mts.map +1 -0
- package/dist/runtime/api-factory.d.mts +2 -2
- package/dist/runtime/api-factory.d.mts.map +1 -1
- package/dist/runtime/api-factory.mjs +3 -2
- package/dist/runtime/api-factory.mjs.map +1 -1
- package/dist/runtime/config.d.mts +12 -0
- package/dist/runtime/config.d.mts.map +1 -1
- package/dist/runtime/config.mjs +8 -4
- package/dist/runtime/config.mjs.map +1 -1
- package/dist/{zitadelNextGen-CXFZoHGo.d.mts → zitadelNextGen-BCljAZpG.d.mts} +157 -95
- package/dist/zitadelNextGen-BCljAZpG.d.mts.map +1 -0
- package/package.json +1 -1
- package/src/generated/endpoints/zitadelNextGen.msw.ts +538 -648
- package/src/generated/endpoints/zitadelNextGen.ts +449 -343
- package/src/generated/endpoints/zitadelNextGen.zod.ts +884 -698
- package/src/generated/model/completeClaim200.ts +19 -0
- package/src/generated/model/{revokeSession404.ts → completeClaim400.ts} +3 -3
- package/src/generated/model/{getMyUserDefaultDetails.ts → completeClaim400Details.ts} +1 -1
- package/src/generated/model/completeClaim401.ts +24 -0
- package/src/generated/model/{revokeSession409.ts → completeClaim404.ts} +3 -3
- package/src/generated/model/{listUsersDefaultDetails.ts → completeClaim404Details.ts} +1 -1
- package/src/generated/model/completeClaim409.ts +26 -0
- package/src/generated/model/completeClaim409Details.ts +14 -0
- package/src/generated/model/completeClaim410.ts +24 -0
- package/src/generated/model/{authorizeGet400.ts → completeClaim429.ts} +3 -3
- package/src/generated/model/{revokeSession404Details.ts → completeClaim429Details.ts} +1 -1
- package/src/generated/model/completeClaimBody.ts +18 -0
- package/src/generated/model/completeClaimDefault.ts +20 -0
- package/src/generated/model/{createProjectDefaultDetails.ts → completeClaimDefaultDetails.ts} +1 -1
- package/src/generated/model/createAuthAttempt201.ts +2 -2
- package/src/generated/model/createAuthAttempt201ChallengesItem.ts +2 -2
- package/src/generated/model/createAuthAttemptDefault.ts +20 -0
- package/src/generated/model/createBranding201.ts +31 -0
- package/src/generated/model/createBranding201Branding.ts +49 -0
- package/src/generated/model/createBranding201BrandingLayout.ts +22 -0
- package/src/generated/model/createBranding400.ts +20 -0
- package/src/generated/model/{createUserDefaultDetails.ts → createBranding400Details.ts} +1 -1
- package/src/generated/model/createBrandingBody.ts +49 -0
- package/src/generated/model/createBrandingBodyLayout.ts +22 -0
- package/src/generated/model/createBrandingDefault.ts +20 -0
- package/src/generated/model/{submitFlowStepDefaultDetails.ts → createBrandingDefaultDetails.ts} +1 -1
- package/src/generated/model/{activateFlowDefinitionParams.ts → createBrandingParams.ts} +1 -1
- package/src/generated/model/createFlow201.ts +8 -3
- package/src/generated/model/createFlow201Branding.ts +23 -7
- package/src/generated/model/createFlow201BrandingLayout.ts +2 -1
- package/src/generated/model/createFlow201Step.ts +5 -3
- package/src/generated/model/createFlowDefault.ts +131 -12
- package/src/generated/model/createFlowDefinitionDefault.ts +91 -12
- package/src/generated/model/createHandoffDefault.ts +31 -1
- package/src/generated/model/createProject201.ts +4 -4
- package/src/generated/model/createProjectBody.ts +2 -2
- package/src/generated/model/createProjectDefault.ts +101 -12
- package/src/generated/model/createSchemaBody.ts +5 -2
- package/src/generated/model/createSession201Session.ts +2 -3
- package/src/generated/model/createSession201SessionState.ts +0 -2
- package/src/generated/model/createSessionDefault.ts +81 -12
- package/src/generated/model/createTeam201.ts +15 -1
- package/src/generated/model/createTeam201Status.ts +21 -0
- package/src/generated/model/{introspect400.ts → createTeam401.ts} +3 -3
- package/src/generated/model/{getToken4xxDetails.ts → createTeam401Details.ts} +1 -1
- package/src/generated/model/{endSession400.ts → createTeam403.ts} +3 -3
- package/src/generated/model/{introspect400Details.ts → createTeam403Details.ts} +1 -1
- package/src/generated/model/{getToken4xx.ts → createTeam404.ts} +3 -3
- package/src/generated/model/{endSession400Details.ts → createTeam404Details.ts} +1 -1
- package/src/generated/model/createTeam409.ts +20 -0
- package/src/generated/model/createTeam409Details.ts +12 -0
- package/src/generated/model/createTeamBody.ts +8 -1
- package/src/generated/model/createUserBody.ts +10 -1
- package/src/generated/model/createUserBodyMetadata.ts +24 -0
- package/src/generated/model/createUserBodyMetadataStatus.ts +20 -0
- package/src/generated/model/createUserDefault.ts +71 -12
- package/src/generated/model/deleteFlowDefinitionDefault.ts +71 -12
- package/src/generated/model/deleteTeam400.ts +20 -0
- package/src/generated/model/deleteTeam400Details.ts +12 -0
- package/src/generated/model/deleteTeam401.ts +20 -0
- package/src/generated/model/deleteTeam401Details.ts +12 -0
- package/src/generated/model/deleteTeam403.ts +20 -0
- package/src/generated/model/deleteTeam403Details.ts +12 -0
- package/src/generated/model/{endSessionDefault.ts → deleteTeamDefault.ts} +3 -3
- package/src/generated/model/{endSessionDefaultDetails.ts → deleteTeamDefaultDetails.ts} +1 -1
- package/src/generated/model/{deactivateFlowDefinitionParams.ts → deleteTeamParams.ts} +1 -1
- package/src/generated/model/deleteUserByID401.ts +20 -0
- package/src/generated/model/{createFlowDefaultDetails.ts → deleteUserByID401Details.ts} +1 -1
- package/src/generated/model/deleteUserByID404.ts +20 -0
- package/src/generated/model/{getProjectDefaultDetails.ts → deleteUserByID404Details.ts} +1 -1
- package/src/generated/model/deleteUserByIDDefault.ts +59 -0
- package/src/generated/model/deleteUserByIDParams.ts +15 -0
- package/src/generated/model/exchangeHandoff200Session.ts +2 -3
- package/src/generated/model/exchangeHandoff200SessionState.ts +0 -2
- package/src/generated/model/exchangeHandoffDefault.ts +141 -12
- package/src/generated/model/getAuthAttempt200.ts +2 -2
- package/src/generated/model/getAuthAttempt200ChallengesItem.ts +2 -2
- package/src/generated/model/getAuthAttemptDefault.ts +20 -0
- package/src/generated/model/getBrandingById200.ts +31 -0
- package/src/generated/model/getBrandingById200Branding.ts +49 -0
- package/src/generated/model/getBrandingById200BrandingLayout.ts +22 -0
- package/src/generated/model/{authorizeDevice400.ts → getBrandingById404.ts} +3 -3
- package/src/generated/model/{getFlowStepDefaultDetails.ts → getBrandingById404Details.ts} +1 -1
- package/src/generated/model/{authorizeDeviceDefault.ts → getBrandingByIdDefault.ts} +3 -3
- package/src/generated/model/{exchangeHandoffDefaultDetails.ts → getBrandingByIdDefaultDetails.ts} +1 -1
- package/src/generated/model/getBrandingByIdParams.ts +15 -0
- package/src/generated/model/getClaimStatus200.ts +31 -0
- package/src/generated/model/getClaimStatus401.ts +20 -0
- package/src/generated/model/getClaimStatus401Details.ts +12 -0
- package/src/generated/model/getClaimStatus403.ts +24 -0
- package/src/generated/model/getClaimStatus404.ts +20 -0
- package/src/generated/model/getClaimStatus404Details.ts +12 -0
- package/src/generated/model/getClaimStatus410.ts +24 -0
- package/src/generated/model/getClaimStatus429.ts +20 -0
- package/src/generated/model/getClaimStatus429Details.ts +12 -0
- package/src/generated/model/getClaimStatusDefault.ts +20 -0
- package/src/generated/model/{authorizeGet400Details.ts → getClaimStatusDefaultDetails.ts} +1 -1
- package/src/generated/model/getClaimStatusParams.ts +15 -0
- package/src/generated/model/getFlowDefinitionDefault.ts +71 -12
- package/src/generated/model/getFlowStep200.ts +8 -3
- package/src/generated/model/getFlowStep200Branding.ts +23 -7
- package/src/generated/model/getFlowStep200BrandingLayout.ts +2 -1
- package/src/generated/model/getFlowStep200Step.ts +5 -3
- package/src/generated/model/getFlowStepDefault.ts +111 -12
- package/src/generated/model/getMySession200.ts +2 -3
- package/src/generated/model/getMySession200State.ts +0 -2
- package/src/generated/model/getMySession401.ts +7 -3
- package/src/generated/model/getMySession404.ts +7 -3
- package/src/generated/model/getMySessionDefault.ts +21 -1
- package/src/generated/model/getMyUser200.ts +17 -1
- package/src/generated/model/getMyUser200Metadata.ts +24 -0
- package/src/generated/model/getMyUser200MetadataStatus.ts +20 -0
- package/src/generated/model/getMyUserDefault.ts +51 -12
- package/src/generated/model/getProject200.ts +3 -3
- package/src/generated/model/getProjectDefault.ts +71 -12
- package/src/generated/model/getSchemaById200.ts +5 -2
- package/src/generated/model/getSession200.ts +2 -3
- package/src/generated/model/getSession200State.ts +0 -2
- package/src/generated/model/getSession403.ts +20 -0
- package/src/generated/model/getSession403Details.ts +12 -0
- package/src/generated/model/getSessionDefault.ts +31 -1
- package/src/generated/model/getTeam200.ts +12 -3
- package/src/generated/model/getTeam200Status.ts +21 -0
- package/src/generated/model/getUserByID200.ts +17 -1
- package/src/generated/model/getUserByID200Metadata.ts +24 -0
- package/src/generated/model/getUserByID200MetadataStatus.ts +20 -0
- package/src/generated/model/getUserByIDDefault.ts +51 -12
- package/src/generated/model/index.ts +186 -126
- package/src/generated/model/initClaim201.ts +24 -0
- package/src/generated/model/{getKeys4xx.ts → initClaim401.ts} +3 -3
- package/src/generated/model/{getKeys4xxDetails.ts → initClaim401Details.ts} +1 -1
- package/src/generated/model/initClaim404.ts +24 -0
- package/src/generated/model/{activateFlowDefinition400.ts → initClaim409.ts} +10 -4
- package/src/generated/model/initClaim409Details.ts +14 -0
- package/src/generated/model/initClaimDefault.ts +20 -0
- package/src/generated/model/{revokeSession409Details.ts → initClaimDefaultDetails.ts} +1 -1
- package/src/generated/model/issueChallenge201.ts +2 -2
- package/src/generated/model/issueChallengeDefault.ts +22 -2
- package/src/generated/model/listBranding200Item.ts +14 -0
- package/src/generated/model/{authorizeGetDefault.ts → listBrandingDefault.ts} +3 -3
- package/src/generated/model/{authorizeGetDefaultDetails.ts → listBrandingDefaultDetails.ts} +1 -1
- package/src/generated/model/listBrandingParams.ts +15 -0
- package/src/generated/model/listFlowDefinitionsDefault.ts +71 -12
- package/src/generated/model/listSchemas200Item.ts +1 -1
- package/src/generated/model/listUserPasskeys200.ts +19 -0
- package/src/generated/model/listUserPasskeys200PasskeysItem.ts +16 -0
- package/src/generated/model/listUserPasskeys400.ts +20 -0
- package/src/generated/model/{listSessionsDefaultDetails.ts → listUserPasskeys400Details.ts} +1 -1
- package/src/generated/model/listUserPasskeys401.ts +20 -0
- package/src/generated/model/{patchProjectDefaultDetails.ts → listUserPasskeys401Details.ts} +1 -1
- package/src/generated/model/listUserPasskeys403.ts +20 -0
- package/src/generated/model/{authorizeDevice400Details.ts → listUserPasskeys403Details.ts} +1 -1
- package/src/generated/model/listUserPasskeys404.ts +20 -0
- package/src/generated/model/listUserPasskeys404Details.ts +12 -0
- package/src/generated/model/listUserPasskeys500.ts +20 -0
- package/src/generated/model/listUserPasskeys500Details.ts +12 -0
- package/src/generated/model/listUserPasskeysDefault.ts +59 -0
- package/src/generated/model/{listSessionsParams.ts → listUserPasskeysParams.ts} +1 -11
- package/src/generated/model/listUserTeams200.ts +19 -0
- package/src/generated/model/listUserTeams200TeamsItem.ts +33 -0
- package/src/generated/model/listUserTeams200TeamsItemMembershipStatus.ts +21 -0
- package/src/generated/model/listUserTeams400.ts +20 -0
- package/src/generated/model/listUserTeams400Details.ts +12 -0
- package/src/generated/model/listUserTeams401.ts +20 -0
- package/src/generated/model/listUserTeams401Details.ts +12 -0
- package/src/generated/model/listUserTeams403.ts +20 -0
- package/src/generated/model/listUserTeams403Details.ts +12 -0
- package/src/generated/model/listUserTeams404.ts +20 -0
- package/src/generated/model/listUserTeams404Details.ts +12 -0
- package/src/generated/model/listUserTeams500.ts +20 -0
- package/src/generated/model/listUserTeams500Details.ts +12 -0
- package/src/generated/model/listUserTeamsDefault.ts +79 -0
- package/src/generated/model/listUserTeamsParams.ts +29 -0
- package/src/generated/model/listUsers200.ts +19 -0
- package/src/generated/model/listUsers200UsersItem.ts +25 -0
- package/src/generated/model/listUsers200UsersItemMetadata.ts +24 -0
- package/src/generated/model/listUsers200UsersItemMetadataStatus.ts +20 -0
- package/src/generated/model/listUsersDefault.ts +51 -12
- package/src/generated/model/listUsersParams.ts +8 -5
- package/src/generated/model/patchProject200.ts +3 -3
- package/src/generated/model/patchProjectDefault.ts +71 -12
- package/src/generated/model/queryProjects200.ts +2 -1
- package/src/generated/model/queryProjects200ProjectsItem.ts +3 -3
- package/src/generated/model/queryProjectsBody.ts +4 -1
- package/src/generated/model/queryProjectsBodyFilterItemField.ts +1 -2
- package/src/generated/model/queryProjectsBodySortingField.ts +1 -2
- package/src/generated/model/queryProjectsDefault.ts +71 -12
- package/src/generated/model/{listSessions200.ts → querySessions200.ts} +3 -3
- package/src/generated/model/{listSessions200SessionsItem.ts → querySessions200SessionsItem.ts} +11 -12
- package/src/generated/model/{listSessions200SessionsItemFactorsItem.ts → querySessions200SessionsItemFactorsItem.ts} +5 -5
- package/src/generated/model/{listSessions200SessionsItemFactorsItemMethod.ts → querySessions200SessionsItemFactorsItemMethod.ts} +3 -3
- package/src/generated/model/{listSessions200SessionsItemFactorsItemPayload.ts → querySessions200SessionsItemFactorsItemPayload.ts} +1 -1
- package/src/generated/model/{listSessions200SessionsItemMetadata.ts → querySessions200SessionsItemMetadata.ts} +1 -1
- package/src/generated/model/{listSessions200SessionsItemState.ts → querySessions200SessionsItemState.ts} +3 -5
- package/src/generated/model/{listSessions200SessionsItemUserAgent.ts → querySessions200SessionsItemUserAgent.ts} +1 -1
- package/src/generated/model/querySessions400.ts +20 -0
- package/src/generated/model/querySessions400Details.ts +12 -0
- package/src/generated/model/querySessions401.ts +20 -0
- package/src/generated/model/querySessions401Details.ts +12 -0
- package/src/generated/model/querySessions403.ts +20 -0
- package/src/generated/model/querySessions403Details.ts +12 -0
- package/src/generated/model/querySessionsBody.ts +25 -0
- package/src/generated/model/querySessionsBodyFilterItem.ts +27 -0
- package/src/generated/model/querySessionsBodyFilterItemField.ts +23 -0
- package/src/generated/model/querySessionsBodyFilterItemOperation.ts +26 -0
- package/src/generated/model/querySessionsBodySorting.ts +18 -0
- package/src/generated/model/querySessionsBodySortingDirection.ts +15 -0
- package/src/generated/model/querySessionsBodySortingField.ts +21 -0
- package/src/generated/model/querySessionsDefault.ts +69 -0
- package/src/generated/model/querySessionsParams.ts +15 -0
- package/src/generated/model/queryTeams200.ts +20 -0
- package/src/generated/model/queryTeams200TeamsItem.ts +28 -0
- package/src/generated/model/queryTeams200TeamsItemStatus.ts +22 -0
- package/src/generated/model/queryTeams400.ts +20 -0
- package/src/generated/model/queryTeams400Details.ts +12 -0
- package/src/generated/model/queryTeams401.ts +20 -0
- package/src/generated/model/queryTeams401Details.ts +12 -0
- package/src/generated/model/queryTeams403.ts +20 -0
- package/src/generated/model/queryTeams403Details.ts +12 -0
- package/src/generated/model/queryTeams404.ts +20 -0
- package/src/generated/model/queryTeams404Details.ts +12 -0
- package/src/generated/model/queryTeams429.ts +20 -0
- package/src/generated/model/queryTeams429Details.ts +12 -0
- package/src/generated/model/queryTeamsBody.ts +28 -0
- package/src/generated/model/queryTeamsBodyFilterItem.ts +22 -0
- package/src/generated/model/queryTeamsBodyFilterItemField.ts +14 -0
- package/src/generated/model/queryTeamsBodyFilterItemOperation.ts +26 -0
- package/src/generated/model/queryTeamsBodySorting.ts +14 -0
- package/src/generated/model/queryTeamsBodySortingDirection.ts +15 -0
- package/src/generated/model/queryTeamsBodySortingField.ts +14 -0
- package/src/generated/model/{introspectDefault.ts → queryTeamsDefault.ts} +3 -3
- package/src/generated/model/queryTeamsDefaultDetails.ts +12 -0
- package/src/generated/model/queryTeamsParams.ts +15 -0
- package/src/generated/model/revokeMySession401.ts +7 -3
- package/src/generated/model/revokeMySessionDefault.ts +41 -12
- package/src/generated/model/revokeSession403.ts +20 -0
- package/src/generated/model/revokeSession403Details.ts +12 -0
- package/src/generated/model/revokeSessionDefault.ts +51 -12
- package/src/generated/model/setUserPasswordBody.ts +1 -1
- package/src/generated/model/setUserPasswordDefault.ts +61 -12
- package/src/generated/model/submitFlowStep200.ts +8 -3
- package/src/generated/model/submitFlowStep200Branding.ts +23 -7
- package/src/generated/model/submitFlowStep200BrandingLayout.ts +2 -1
- package/src/generated/model/submitFlowStep200Step.ts +5 -3
- package/src/generated/model/submitFlowStep400.ts +8 -3
- package/src/generated/model/submitFlowStep400Branding.ts +23 -7
- package/src/generated/model/submitFlowStep400BrandingLayout.ts +2 -1
- package/src/generated/model/submitFlowStep400Step.ts +5 -3
- package/src/generated/model/submitFlowStepDefault.ts +261 -12
- package/src/generated/model/updateFlowDefinitionDefault.ts +111 -12
- package/src/generated/model/updateTeam200.ts +28 -0
- package/src/generated/model/updateTeam200Status.ts +21 -0
- package/src/generated/model/updateTeam400.ts +20 -0
- package/src/generated/model/updateTeam400Details.ts +12 -0
- package/src/generated/model/updateTeam401.ts +20 -0
- package/src/generated/model/updateTeam401Details.ts +12 -0
- package/src/generated/model/updateTeam403.ts +20 -0
- package/src/generated/model/updateTeam403Details.ts +12 -0
- package/src/generated/model/updateTeam404.ts +20 -0
- package/src/generated/model/updateTeam404Details.ts +12 -0
- package/src/generated/model/updateTeam409.ts +20 -0
- package/src/generated/model/updateTeam409Details.ts +12 -0
- package/src/generated/model/updateTeamBody.ts +16 -0
- package/src/generated/model/updateTeamDefault.ts +20 -0
- package/src/generated/model/updateTeamDefaultDetails.ts +12 -0
- package/src/generated/model/updateTeamParams.ts +15 -0
- package/src/generated/model/verifyChallengeProof200.ts +2 -2
- package/src/generated/model/verifyChallengeProof200ChallengesItem.ts +2 -2
- package/src/generated/model/verifyChallengeProofDefault.ts +34 -4
- package/src/runtime/api-factory.ts +5 -2
- package/src/runtime/config.spec.ts +31 -1
- package/src/runtime/config.ts +22 -3
- package/dist/index-oloR8wb4.d.mts.map +0 -1
- package/dist/zitadelNextGen-CXFZoHGo.d.mts.map +0 -1
- package/src/generated/model/activateFlowDefinition400Details.ts +0 -12
- package/src/generated/model/activateFlowDefinitionDefault.ts +0 -20
- package/src/generated/model/activateFlowDefinitionDefaultDetails.ts +0 -12
- package/src/generated/model/authorizeDevice200.ts +0 -30
- package/src/generated/model/authorizeDeviceDefaultDetails.ts +0 -12
- package/src/generated/model/authorizeDeviceParams.ts +0 -25
- package/src/generated/model/authorizeGetParams.ts +0 -136
- package/src/generated/model/createFlowDefinitionDefaultDetails.ts +0 -12
- package/src/generated/model/createSessionDefaultDetails.ts +0 -12
- package/src/generated/model/deactivateFlowDefinition400.ts +0 -20
- package/src/generated/model/deactivateFlowDefinition400Details.ts +0 -12
- package/src/generated/model/deactivateFlowDefinition409.ts +0 -20
- package/src/generated/model/deactivateFlowDefinition409Details.ts +0 -12
- package/src/generated/model/deactivateFlowDefinitionDefault.ts +0 -20
- package/src/generated/model/deactivateFlowDefinitionDefaultDetails.ts +0 -12
- package/src/generated/model/deleteFlowDefinitionDefaultDetails.ts +0 -12
- package/src/generated/model/endSessionParams.ts +0 -57
- package/src/generated/model/getFlowDefinitionDefaultDetails.ts +0 -12
- package/src/generated/model/getKeys200.ts +0 -12
- package/src/generated/model/getKeys200KeysItem.ts +0 -30
- package/src/generated/model/getKeysDefault.ts +0 -20
- package/src/generated/model/getKeysDefaultDetails.ts +0 -12
- package/src/generated/model/getMySession401Details.ts +0 -12
- package/src/generated/model/getMySession404Details.ts +0 -12
- package/src/generated/model/getOpenIDConfiguration200.ts +0 -87
- package/src/generated/model/getOpenIDConfiguration200ClaimTypesSupportedItem.ts +0 -16
- package/src/generated/model/getOpenIDConfiguration200DisplayValuesSupportedItem.ts +0 -17
- package/src/generated/model/getOpenIDConfiguration200SubjectTypesSupportedItem.ts +0 -15
- package/src/generated/model/getOpenIDConfiguration200TokenEndpointAuthMethodsSupportedItem.ts +0 -17
- package/src/generated/model/getOpenIDConfiguration4xx.ts +0 -20
- package/src/generated/model/getOpenIDConfiguration4xxDetails.ts +0 -12
- package/src/generated/model/getOpenIDConfigurationDefault.ts +0 -20
- package/src/generated/model/getOpenIDConfigurationDefaultDetails.ts +0 -12
- package/src/generated/model/getToken200.ts +0 -18
- package/src/generated/model/getTokenBody.ts +0 -40
- package/src/generated/model/getTokenBodyGrantType.ts +0 -20
- package/src/generated/model/getTokenDefault.ts +0 -20
- package/src/generated/model/getTokenDefaultDetails.ts +0 -12
- package/src/generated/model/getUserByIDDefaultDetails.ts +0 -12
- package/src/generated/model/getUserInfo200.ts +0 -24
- package/src/generated/model/getUserInfo4xx.ts +0 -20
- package/src/generated/model/getUserInfo4xxDetails.ts +0 -12
- package/src/generated/model/getUserInfoDefault.ts +0 -20
- package/src/generated/model/getUserInfoDefaultDetails.ts +0 -12
- package/src/generated/model/introspect200.ts +0 -34
- package/src/generated/model/introspectBody.ts +0 -14
- package/src/generated/model/introspectDefaultDetails.ts +0 -12
- package/src/generated/model/listFlowDefinitionsDefaultDetails.ts +0 -12
- package/src/generated/model/listSessions400.ts +0 -20
- package/src/generated/model/listSessions400Details.ts +0 -12
- package/src/generated/model/listSessions401.ts +0 -20
- package/src/generated/model/listSessions401Details.ts +0 -12
- package/src/generated/model/listSessions403.ts +0 -20
- package/src/generated/model/listSessions403Details.ts +0 -12
- package/src/generated/model/listSessionsDefault.ts +0 -20
- package/src/generated/model/listSessionsState.ts +0 -16
- package/src/generated/model/listUsers200Item.ts +0 -9
- package/src/generated/model/queryProjectsDefaultDetails.ts +0 -12
- package/src/generated/model/revokeMySession401Details.ts +0 -12
- package/src/generated/model/revokeMySession404.ts +0 -20
- package/src/generated/model/revokeMySession404Details.ts +0 -12
- package/src/generated/model/revokeMySession409.ts +0 -20
- package/src/generated/model/revokeMySession409Details.ts +0 -12
- package/src/generated/model/revokeMySessionDefaultDetails.ts +0 -12
- package/src/generated/model/revokeSessionDefaultDetails.ts +0 -12
- package/src/generated/model/revokeToken4xx.ts +0 -20
- package/src/generated/model/revokeToken4xxDetails.ts +0 -12
- package/src/generated/model/revokeTokenBody.ts +0 -14
- package/src/generated/model/revokeTokenDefault.ts +0 -20
- package/src/generated/model/revokeTokenDefaultDetails.ts +0 -12
- package/src/generated/model/setUserPasswordDefaultDetails.ts +0 -12
- package/src/generated/model/submitFlowEvent400.ts +0 -20
- package/src/generated/model/submitFlowEvent400Details.ts +0 -12
- package/src/generated/model/submitFlowEvent404.ts +0 -20
- package/src/generated/model/submitFlowEvent404Details.ts +0 -12
- package/src/generated/model/submitFlowEventBody.ts +0 -17
- package/src/generated/model/submitFlowEventBodyPayload.ts +0 -12
- package/src/generated/model/submitFlowEventBodyType.ts +0 -15
- package/src/generated/model/submitFlowEventDefault.ts +0 -20
- package/src/generated/model/submitFlowEventDefaultDetails.ts +0 -12
- package/src/generated/model/updateFlowDefinitionDefaultDetails.ts +0 -12
|
@@ -7,508 +7,6 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import * as zod from "zod";
|
|
9
9
|
|
|
10
|
-
/**
|
|
11
|
-
* Retrieve the OpenID Connect configuration
|
|
12
|
-
* @summary Get OpenID Connect configuration
|
|
13
|
-
*/
|
|
14
|
-
export const getOpenIDConfigurationResponseClaimsParameterSupportedDefault = false;
|
|
15
|
-
export const getOpenIDConfigurationResponseRequestParameterSupportedDefault = false;
|
|
16
|
-
export const getOpenIDConfigurationResponseRequestUriParameterSupportedDefault = true;
|
|
17
|
-
export const getOpenIDConfigurationResponseRequireRequestUriRegistrationDefault = false;
|
|
18
|
-
|
|
19
|
-
export const GetOpenIDConfigurationResponse = zod
|
|
20
|
-
.object({
|
|
21
|
-
issuer: zod
|
|
22
|
-
.url()
|
|
23
|
-
.describe(
|
|
24
|
-
"REQUIRED. URL using the https scheme with no query or fragment components that the OP asserts as its Issuer Identifier.",
|
|
25
|
-
),
|
|
26
|
-
authorization_endpoint: zod
|
|
27
|
-
.url()
|
|
28
|
-
.describe("REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint."),
|
|
29
|
-
token_endpoint: zod
|
|
30
|
-
.url()
|
|
31
|
-
.optional()
|
|
32
|
-
.describe(
|
|
33
|
-
"URL of the OP's OAuth 2.0 Token Endpoint. REQUIRED unless only the Implicit Flow is used.",
|
|
34
|
-
),
|
|
35
|
-
userinfo_endpoint: zod
|
|
36
|
-
.url()
|
|
37
|
-
.optional()
|
|
38
|
-
.describe("RECOMMENDED. URL of the OP's UserInfo Endpoint."),
|
|
39
|
-
jwks_uri: zod
|
|
40
|
-
.url()
|
|
41
|
-
.describe(
|
|
42
|
-
"REQUIRED. URL of the OP's JWK Set document containing the signing key(s) the RP uses to validate signatures from the OP.",
|
|
43
|
-
),
|
|
44
|
-
registration_endpoint: zod
|
|
45
|
-
.url()
|
|
46
|
-
.optional()
|
|
47
|
-
.describe("RECOMMENDED. URL of the OP's Dynamic Client Registration Endpoint."),
|
|
48
|
-
scopes_supported: zod
|
|
49
|
-
.array(zod.string())
|
|
50
|
-
.optional()
|
|
51
|
-
.describe(
|
|
52
|
-
"RECOMMENDED. JSON array containing a list of the OAuth 2.0 scope values that this server supports. The server MUST support the openid scope value.",
|
|
53
|
-
),
|
|
54
|
-
response_types_supported: zod
|
|
55
|
-
.array(zod.string())
|
|
56
|
-
.describe(
|
|
57
|
-
"REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports.",
|
|
58
|
-
),
|
|
59
|
-
response_modes_supported: zod
|
|
60
|
-
.array(zod.string())
|
|
61
|
-
.optional()
|
|
62
|
-
.describe(
|
|
63
|
-
'OPTIONAL. JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports. Default is [\"query\", \"fragment\"].',
|
|
64
|
-
),
|
|
65
|
-
grant_types_supported: zod
|
|
66
|
-
.array(zod.string())
|
|
67
|
-
.optional()
|
|
68
|
-
.describe(
|
|
69
|
-
'OPTIONAL. JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. Default is [\"authorization_code\", \"implicit\"].',
|
|
70
|
-
),
|
|
71
|
-
acr_values_supported: zod
|
|
72
|
-
.array(zod.string())
|
|
73
|
-
.optional()
|
|
74
|
-
.describe(
|
|
75
|
-
"OPTIONAL. JSON array containing a list of the Authentication Context Class References that this OP supports.",
|
|
76
|
-
),
|
|
77
|
-
subject_types_supported: zod
|
|
78
|
-
.array(zod.enum(["public", "pairwise"]))
|
|
79
|
-
.describe(
|
|
80
|
-
"REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.",
|
|
81
|
-
),
|
|
82
|
-
id_token_signing_alg_values_supported: zod
|
|
83
|
-
.array(zod.string())
|
|
84
|
-
.describe(
|
|
85
|
-
"REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token. The algorithm RS256 MUST be included.",
|
|
86
|
-
),
|
|
87
|
-
id_token_encryption_alg_values_supported: zod
|
|
88
|
-
.array(zod.string())
|
|
89
|
-
.optional()
|
|
90
|
-
.describe(
|
|
91
|
-
"OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token.",
|
|
92
|
-
),
|
|
93
|
-
id_token_encryption_enc_values_supported: zod
|
|
94
|
-
.array(zod.string())
|
|
95
|
-
.optional()
|
|
96
|
-
.describe(
|
|
97
|
-
"OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token.",
|
|
98
|
-
),
|
|
99
|
-
userinfo_signing_alg_values_supported: zod
|
|
100
|
-
.array(zod.string())
|
|
101
|
-
.optional()
|
|
102
|
-
.describe(
|
|
103
|
-
"OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the UserInfo Endpoint.",
|
|
104
|
-
),
|
|
105
|
-
userinfo_encryption_alg_values_supported: zod
|
|
106
|
-
.array(zod.string())
|
|
107
|
-
.optional()
|
|
108
|
-
.describe(
|
|
109
|
-
"OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the UserInfo Endpoint.",
|
|
110
|
-
),
|
|
111
|
-
userinfo_encryption_enc_values_supported: zod
|
|
112
|
-
.array(zod.string())
|
|
113
|
-
.optional()
|
|
114
|
-
.describe(
|
|
115
|
-
"OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the UserInfo Endpoint.",
|
|
116
|
-
),
|
|
117
|
-
request_object_signing_alg_values_supported: zod
|
|
118
|
-
.array(zod.string())
|
|
119
|
-
.optional()
|
|
120
|
-
.describe(
|
|
121
|
-
"OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects. Servers SHOULD support none and RS256.",
|
|
122
|
-
),
|
|
123
|
-
request_object_encryption_alg_values_supported: zod
|
|
124
|
-
.array(zod.string())
|
|
125
|
-
.optional()
|
|
126
|
-
.describe(
|
|
127
|
-
"OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects.",
|
|
128
|
-
),
|
|
129
|
-
request_object_encryption_enc_values_supported: zod
|
|
130
|
-
.array(zod.string())
|
|
131
|
-
.optional()
|
|
132
|
-
.describe(
|
|
133
|
-
"OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects.",
|
|
134
|
-
),
|
|
135
|
-
token_endpoint_auth_methods_supported: zod
|
|
136
|
-
.array(
|
|
137
|
-
zod.enum([
|
|
138
|
-
"client_secret_post",
|
|
139
|
-
"client_secret_basic",
|
|
140
|
-
"client_secret_jwt",
|
|
141
|
-
"private_key_jwt",
|
|
142
|
-
]),
|
|
143
|
-
)
|
|
144
|
-
.optional()
|
|
145
|
-
.describe(
|
|
146
|
-
"OPTIONAL. JSON array containing a list of Client Authentication methods supported by the Token Endpoint. Default is client_secret_basic.",
|
|
147
|
-
),
|
|
148
|
-
token_endpoint_auth_signing_alg_values_supported: zod
|
|
149
|
-
.array(zod.string())
|
|
150
|
-
.optional()
|
|
151
|
-
.describe(
|
|
152
|
-
"OPTIONAL. JSON array containing a list of the JWS signing algorithms supported by the Token Endpoint for private_key_jwt and client_secret_jwt authentication. The value none MUST NOT be used.",
|
|
153
|
-
),
|
|
154
|
-
display_values_supported: zod
|
|
155
|
-
.array(zod.enum(["page", "popup", "touch", "wap"]))
|
|
156
|
-
.optional()
|
|
157
|
-
.describe(
|
|
158
|
-
"OPTIONAL. JSON array containing a list of the display parameter values that the OpenID Provider supports.",
|
|
159
|
-
),
|
|
160
|
-
claim_types_supported: zod
|
|
161
|
-
.array(zod.enum(["normal", "aggregated", "distributed"]))
|
|
162
|
-
.optional()
|
|
163
|
-
.describe(
|
|
164
|
-
"OPTIONAL. JSON array containing a list of the Claim Types that the OpenID Provider supports. Default is normal.",
|
|
165
|
-
),
|
|
166
|
-
claims_supported: zod
|
|
167
|
-
.array(zod.string())
|
|
168
|
-
.optional()
|
|
169
|
-
.describe(
|
|
170
|
-
"RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.",
|
|
171
|
-
),
|
|
172
|
-
service_documentation: zod
|
|
173
|
-
.url()
|
|
174
|
-
.optional()
|
|
175
|
-
.describe(
|
|
176
|
-
"OPTIONAL. URL of a page containing human-readable information for developers using the OpenID Provider.",
|
|
177
|
-
),
|
|
178
|
-
claims_locales_supported: zod
|
|
179
|
-
.array(zod.string())
|
|
180
|
-
.optional()
|
|
181
|
-
.describe(
|
|
182
|
-
"OPTIONAL. Languages and scripts supported for values in Claims being returned, as BCP47 language tag values.",
|
|
183
|
-
),
|
|
184
|
-
ui_locales_supported: zod
|
|
185
|
-
.array(zod.string())
|
|
186
|
-
.optional()
|
|
187
|
-
.describe(
|
|
188
|
-
"OPTIONAL. Languages and scripts supported for the user interface, as BCP47 language tag values.",
|
|
189
|
-
),
|
|
190
|
-
claims_parameter_supported: zod
|
|
191
|
-
.boolean()
|
|
192
|
-
.default(getOpenIDConfigurationResponseClaimsParameterSupportedDefault)
|
|
193
|
-
.describe(
|
|
194
|
-
"OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter. Default is false.",
|
|
195
|
-
),
|
|
196
|
-
request_parameter_supported: zod
|
|
197
|
-
.boolean()
|
|
198
|
-
.default(getOpenIDConfigurationResponseRequestParameterSupportedDefault)
|
|
199
|
-
.describe(
|
|
200
|
-
"OPTIONAL. Boolean value specifying whether the OP supports use of the request parameter. Default is false.",
|
|
201
|
-
),
|
|
202
|
-
request_uri_parameter_supported: zod
|
|
203
|
-
.boolean()
|
|
204
|
-
.default(getOpenIDConfigurationResponseRequestUriParameterSupportedDefault)
|
|
205
|
-
.describe(
|
|
206
|
-
"OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter. Default is true.",
|
|
207
|
-
),
|
|
208
|
-
require_request_uri_registration: zod
|
|
209
|
-
.boolean()
|
|
210
|
-
.default(getOpenIDConfigurationResponseRequireRequestUriRegistrationDefault)
|
|
211
|
-
.describe(
|
|
212
|
-
"OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be pre-registered. Default is false.",
|
|
213
|
-
),
|
|
214
|
-
op_policy_uri: zod
|
|
215
|
-
.url()
|
|
216
|
-
.optional()
|
|
217
|
-
.describe(
|
|
218
|
-
"OPTIONAL. URL the OP provides to the person registering the Client about the OP's requirements on how the Relying Party can use the data provided.",
|
|
219
|
-
),
|
|
220
|
-
op_tos_uri: zod
|
|
221
|
-
.url()
|
|
222
|
-
.optional()
|
|
223
|
-
.describe(
|
|
224
|
-
"OPTIONAL. URL the OP provides to the person registering the Client about the OpenID Provider's terms of service.",
|
|
225
|
-
),
|
|
226
|
-
})
|
|
227
|
-
.describe(
|
|
228
|
-
"OpenID Connect configuration according to the OpenID Connect Discovery 1.0 specification.",
|
|
229
|
-
);
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* @summary Authorize a user
|
|
233
|
-
*/
|
|
234
|
-
export const AuthorizeGetQueryParams = zod.strictObject({
|
|
235
|
-
acr_values: zod
|
|
236
|
-
.string()
|
|
237
|
-
.optional()
|
|
238
|
-
.describe(
|
|
239
|
-
"A space delimited list of Authentication Class References. This can be\nused to specify certain authentication methods or level of assurance \nthat is required for the authentication. For example, you could use \nthis to require multi-factor authentication.\n",
|
|
240
|
-
),
|
|
241
|
-
client_id: zod
|
|
242
|
-
.string()
|
|
243
|
-
.describe(
|
|
244
|
-
"The client ID of the application that is requesting authorization. \nThis is a required parameter and must match the client ID of a \nregistered application.\n",
|
|
245
|
-
),
|
|
246
|
-
code_challenge: zod
|
|
247
|
-
.string()
|
|
248
|
-
.optional()
|
|
249
|
-
.describe(
|
|
250
|
-
"The code challenge is a cryptographic string used in the PKCE (Proof \nKey for Code Exchange) flow to enhance security.\n",
|
|
251
|
-
),
|
|
252
|
-
code_challenge_method: zod
|
|
253
|
-
.string()
|
|
254
|
-
.optional()
|
|
255
|
-
.describe(
|
|
256
|
-
'The code challenge method is used in conjunction with the code challenge \nin the PKCE flow. It specifies the method used to generate the code \nchallenge. Common values are \"S256\" for SHA-256 hashing and \"plain\" \nfor no hashing.\n',
|
|
257
|
-
),
|
|
258
|
-
display: zod
|
|
259
|
-
.string()
|
|
260
|
-
.optional()
|
|
261
|
-
.describe(
|
|
262
|
-
'The display parameter is used to specify how the authorization server \nshould display the authentication and consent user interface. Common \nvalues include \"page\" for a full-page display, \"popup\" for a popup \nwindow, and \"touch\" for a mobile-optimized display.\n',
|
|
263
|
-
),
|
|
264
|
-
id_token_hint: zod
|
|
265
|
-
.string()
|
|
266
|
-
.optional()
|
|
267
|
-
.describe(
|
|
268
|
-
"The ID token hint is a previously issued ID token that can be used to \npre-fill the authentication form or to provide information about the \nuser to the authorization server. This can be useful for single sign-on \nscenarios or for providing a smoother user experience.\n",
|
|
269
|
-
),
|
|
270
|
-
login_hint: zod
|
|
271
|
-
.string()
|
|
272
|
-
.optional()
|
|
273
|
-
.describe(
|
|
274
|
-
"The login hint is a hint to the authorization server about the login \nidentifier of the user. This can be used to pre-fill the username or \nemail field in the authentication form, making it easier for the user \nto log in.\n",
|
|
275
|
-
),
|
|
276
|
-
max_age: zod
|
|
277
|
-
.number()
|
|
278
|
-
.optional()
|
|
279
|
-
.describe(
|
|
280
|
-
"The max age parameter specifies the maximum amount of time in seconds \nthat has passed since the user last authenticated. If the user has not \nauthenticated within this time frame, they will be required to re-authenticate.\n",
|
|
281
|
-
),
|
|
282
|
-
nonce: zod
|
|
283
|
-
.string()
|
|
284
|
-
.optional()
|
|
285
|
-
.describe(
|
|
286
|
-
"The nonce parameter is a random string that is used to associate a client \nsession with an ID token and to mitigate replay attacks. The authorization \nserver should include this value in the ID token that it issues, and the \nclient should verify that the value in the ID token matches the value it \nsent in the authorization request.\n",
|
|
287
|
-
),
|
|
288
|
-
prompt: zod
|
|
289
|
-
.string()
|
|
290
|
-
.optional()
|
|
291
|
-
.describe(
|
|
292
|
-
'The prompt parameter is used to specify whether the authorization server \nshould prompt the user for re-authentication and consent. Common values \ninclude \"none\" for no prompts, \"login\" to prompt for re-authentication, \n\"consent\" to prompt for user consent, and \"select_account\" to prompt \nthe user to select an account if they are logged in with multiple accounts.\n',
|
|
293
|
-
),
|
|
294
|
-
redirect_uri: zod
|
|
295
|
-
.string()
|
|
296
|
-
.optional()
|
|
297
|
-
.describe(
|
|
298
|
-
"The redirect URI is the URI to which the authorization server will redirect \nthe user after they have authorized or denied the request. This must match \none of the redirect URIs registered for the client application.\n",
|
|
299
|
-
),
|
|
300
|
-
response_mode: zod
|
|
301
|
-
.string()
|
|
302
|
-
.optional()
|
|
303
|
-
.describe(
|
|
304
|
-
'The response mode parameter specifies how the authorization server should \nreturn the authorization response. Common values include \"query\" to return \nparameters in the query string, \"fragment\" to return parameters in the URL \nfragment, and \"form_post\" to return parameters in an HTTP POST request.\n',
|
|
305
|
-
),
|
|
306
|
-
response_type: zod
|
|
307
|
-
.string()
|
|
308
|
-
.describe(
|
|
309
|
-
'The response type parameter specifies the type of response that the client \nis expecting from the authorization server. Common values include \"code\" \nfor the authorization code flow, \"token\" for the implicit flow, and \"id_token\" \nfor OpenID Connect authentication.\n',
|
|
310
|
-
),
|
|
311
|
-
scope: zod
|
|
312
|
-
.string()
|
|
313
|
-
.optional()
|
|
314
|
-
.describe(
|
|
315
|
-
"The scope parameter is used to specify the permissions that the client is \nrequesting from the user. This is a space-delimited list of scope values, \nand the authorization server will use this information to determine what \naccess to grant to the client application.\n",
|
|
316
|
-
),
|
|
317
|
-
state: zod
|
|
318
|
-
.string()
|
|
319
|
-
.optional()
|
|
320
|
-
.describe(
|
|
321
|
-
"The state parameter is a random string that is used to maintain state between \nthe authorization request and the callback. It is used to prevent cross-site \nrequest forgery (CSRF) attacks by ensuring that the response received from the \nauthorization server corresponds to the request that was sent.\n",
|
|
322
|
-
),
|
|
323
|
-
ui_locales: zod
|
|
324
|
-
.string()
|
|
325
|
-
.optional()
|
|
326
|
-
.describe(
|
|
327
|
-
"The ui_locales parameter is used to specify the preferred languages and scripts \nfor the user interface that the authorization server should display. This is a \nspace-delimited list of BCP47 language tag values, and it can be used to provide \na localized user experience for users from different regions and language \npreferences.\n",
|
|
328
|
-
),
|
|
329
|
-
});
|
|
330
|
-
|
|
331
|
-
/**
|
|
332
|
-
* @summary Authorize a device
|
|
333
|
-
*/
|
|
334
|
-
export const AuthorizeDeviceQueryParams = zod.strictObject({
|
|
335
|
-
client_id: zod
|
|
336
|
-
.string()
|
|
337
|
-
.describe(
|
|
338
|
-
"The client ID of the application that is requesting authorization. \nThis is a required parameter and must match the client ID of a \nregistered application.\n",
|
|
339
|
-
),
|
|
340
|
-
scope: zod
|
|
341
|
-
.string()
|
|
342
|
-
.optional()
|
|
343
|
-
.describe(
|
|
344
|
-
"The scope parameter is used to specify the permissions that the client\nis requesting. This is a space delimited list of scopes. For example,\nyou could use this to request access to the user's profile information or\nto request permission to access certain APIs on behalf of the user.\n",
|
|
345
|
-
),
|
|
346
|
-
});
|
|
347
|
-
|
|
348
|
-
export const AuthorizeDeviceResponse = zod.object({
|
|
349
|
-
device_code: zod
|
|
350
|
-
.string()
|
|
351
|
-
.optional()
|
|
352
|
-
.describe("The device code that the client will use to poll for authorization.\n"),
|
|
353
|
-
expires_in: zod
|
|
354
|
-
.number()
|
|
355
|
-
.optional()
|
|
356
|
-
.describe("The number of seconds until the device code expires.\n"),
|
|
357
|
-
interval: zod
|
|
358
|
-
.number()
|
|
359
|
-
.optional()
|
|
360
|
-
.describe(
|
|
361
|
-
"The minimum amount of time in seconds that the client should wait \nbetween polling requests.\n",
|
|
362
|
-
),
|
|
363
|
-
user_code: zod
|
|
364
|
-
.string()
|
|
365
|
-
.optional()
|
|
366
|
-
.describe("The user code that the user will enter to authorize the device.\n"),
|
|
367
|
-
verification_uri: zod
|
|
368
|
-
.string()
|
|
369
|
-
.optional()
|
|
370
|
-
.describe("The URI where the user will enter the user code to authorize the device.\n"),
|
|
371
|
-
verification_uri_complete: zod
|
|
372
|
-
.string()
|
|
373
|
-
.optional()
|
|
374
|
-
.describe(
|
|
375
|
-
"The complete URI with the user code included, which the user can visit\nto authorize the device.\n",
|
|
376
|
-
),
|
|
377
|
-
});
|
|
378
|
-
|
|
379
|
-
/**
|
|
380
|
-
* @summary End a session
|
|
381
|
-
*/
|
|
382
|
-
export const EndSessionQueryParams = zod.strictObject({
|
|
383
|
-
client_id: zod
|
|
384
|
-
.string()
|
|
385
|
-
.optional()
|
|
386
|
-
.describe(
|
|
387
|
-
"The client ID is the identifier for the client application that is making \nthe request. This is used by the authorization server to identify the \nclient and to determine whether it is authorized to perform the requested \naction.\n",
|
|
388
|
-
),
|
|
389
|
-
id_token_hint: zod
|
|
390
|
-
.string()
|
|
391
|
-
.optional()
|
|
392
|
-
.describe(
|
|
393
|
-
"The ID token hint is a previously issued ID token that can be used to \npre-fill the authentication form or to provide information about the \nuser to the authorization server. This can be useful for single sign-on \nscenarios or for providing a smoother user experience.\n",
|
|
394
|
-
),
|
|
395
|
-
logout_hint: zod
|
|
396
|
-
.string()
|
|
397
|
-
.optional()
|
|
398
|
-
.describe(
|
|
399
|
-
"The logout hint is a hint to the authorization server about the login \nidentifier of the user. This can be used to pre-fill the username or email\nfield in the logout form, making it easier for the user to log out.\n",
|
|
400
|
-
),
|
|
401
|
-
post_logout_redirect_uri: zod
|
|
402
|
-
.string()
|
|
403
|
-
.optional()
|
|
404
|
-
.describe(
|
|
405
|
-
"The post logout redirect URI is the URI to which the user will be \nredirected after they have logged out. This must be a registered URI \nfor the client application and is used to ensure that the user is \nredirected to a safe location after logging out.\n",
|
|
406
|
-
),
|
|
407
|
-
state: zod
|
|
408
|
-
.string()
|
|
409
|
-
.optional()
|
|
410
|
-
.describe(
|
|
411
|
-
"The state parameter is an opaque value that is used by the client to\nmaintain state between the request and the callback. It is typically used\nto prevent cross-site request forgery (CSRF) attacks by including a unique\nvalue in the request that the client can verify when it receives the callback.\n",
|
|
412
|
-
),
|
|
413
|
-
ui_locales: zod
|
|
414
|
-
.string()
|
|
415
|
-
.optional()
|
|
416
|
-
.describe(
|
|
417
|
-
"The ui_locales parameter is a space-separated list of BCP47 language tags\nthat are used to indicate the preferred languages and scripts for the user\ninterface. This can be used by the authorization server to display the logout\npage in the user's preferred language.\n",
|
|
418
|
-
),
|
|
419
|
-
});
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* @summary Introspect a token
|
|
423
|
-
*/
|
|
424
|
-
export const IntrospectResponse = zod.object({
|
|
425
|
-
active: zod.boolean().optional().describe("Indicates whether the token is active"),
|
|
426
|
-
aud: zod.string().optional().describe("The audience of the token (if applicable)"),
|
|
427
|
-
client_id: zod.string().optional().describe("The client ID associated with the token"),
|
|
428
|
-
exp: zod
|
|
429
|
-
.number()
|
|
430
|
-
.optional()
|
|
431
|
-
.describe("The expiration time of the token (in seconds since epoch)"),
|
|
432
|
-
iat: zod.number().optional().describe("The time the token was issued (in seconds since epoch)"),
|
|
433
|
-
iss: zod.string().optional().describe("The issuer of the token (if applicable)"),
|
|
434
|
-
jti: zod.string().optional().describe("The unique identifier for the token (if applicable)"),
|
|
435
|
-
nbf: zod
|
|
436
|
-
.number()
|
|
437
|
-
.optional()
|
|
438
|
-
.describe("The time before which the token is not valid (in seconds since epoch)"),
|
|
439
|
-
scope: zod.string().optional().describe("The scopes associated with the token"),
|
|
440
|
-
sub: zod.string().optional().describe("The subject of the token (if applicable)"),
|
|
441
|
-
token_type: zod
|
|
442
|
-
.string()
|
|
443
|
-
.optional()
|
|
444
|
-
.describe("The type of the token (access_token or refresh_token)"),
|
|
445
|
-
username: zod
|
|
446
|
-
.string()
|
|
447
|
-
.optional()
|
|
448
|
-
.describe("The username associated with the token (if applicable)"),
|
|
449
|
-
});
|
|
450
|
-
|
|
451
|
-
/**
|
|
452
|
-
* @summary Get public keys
|
|
453
|
-
*/
|
|
454
|
-
export const GetKeysResponse = zod.object({
|
|
455
|
-
keys: zod
|
|
456
|
-
.array(
|
|
457
|
-
zod.object({
|
|
458
|
-
use: zod.string().optional(),
|
|
459
|
-
kty: zod.string().optional(),
|
|
460
|
-
kid: zod.string().optional(),
|
|
461
|
-
crv: zod.string().optional(),
|
|
462
|
-
alg: zod.string().optional(),
|
|
463
|
-
k: zod.string().optional(),
|
|
464
|
-
x: zod.string().optional(),
|
|
465
|
-
y: zod.string().optional(),
|
|
466
|
-
n: zod.string().optional(),
|
|
467
|
-
e: zod.string().optional(),
|
|
468
|
-
d: zod.string().optional(),
|
|
469
|
-
p: zod.string().optional(),
|
|
470
|
-
q: zod.string().optional(),
|
|
471
|
-
dp: zod.string().optional(),
|
|
472
|
-
dq: zod.string().optional(),
|
|
473
|
-
qi: zod.string().optional(),
|
|
474
|
-
x5c: zod.array(zod.string()).optional(),
|
|
475
|
-
x5u: zod.string().optional(),
|
|
476
|
-
x5t: zod.string().optional(),
|
|
477
|
-
x5tS256: zod.string().optional(),
|
|
478
|
-
}),
|
|
479
|
-
)
|
|
480
|
-
.optional(),
|
|
481
|
-
});
|
|
482
|
-
|
|
483
|
-
/**
|
|
484
|
-
* @summary Get access token
|
|
485
|
-
*/
|
|
486
|
-
export const GetTokenResponse = zod.object({
|
|
487
|
-
access_token: zod
|
|
488
|
-
.string()
|
|
489
|
-
.optional()
|
|
490
|
-
.describe("The access token issued by the authorization server."),
|
|
491
|
-
token_type: zod.string().optional().describe("The type of the token issued (e.g., Bearer)."),
|
|
492
|
-
expires_in: zod.number().optional().describe("The lifetime in seconds of the access token."),
|
|
493
|
-
refresh_token: zod
|
|
494
|
-
.string()
|
|
495
|
-
.optional()
|
|
496
|
-
.describe("The refresh token which can be used to obtain new access tokens."),
|
|
497
|
-
});
|
|
498
|
-
|
|
499
|
-
/**
|
|
500
|
-
* @summary Get user info
|
|
501
|
-
*/
|
|
502
|
-
export const GetUserInfoResponse = zod.object({
|
|
503
|
-
sub: zod.string().optional().describe("The unique identifier for the user."),
|
|
504
|
-
name: zod.string().optional().describe("The full name of the user."),
|
|
505
|
-
email: zod.email().optional().describe("The email address of the user."),
|
|
506
|
-
preferred_username: zod.string().optional().describe("The preferred username of the user."),
|
|
507
|
-
picture: zod.url().optional().describe("The URL of the user's profile picture."),
|
|
508
|
-
given_name: zod.string().optional().describe("The given name of the user."),
|
|
509
|
-
family_name: zod.string().optional().describe("The family name of the user."),
|
|
510
|
-
});
|
|
511
|
-
|
|
512
10
|
/**
|
|
513
11
|
* @summary Create user
|
|
514
12
|
*/
|
|
@@ -527,37 +25,96 @@ export const CreateUserQueryParams = zod.strictObject({
|
|
|
527
25
|
.describe("The unique identifier of the team"),
|
|
528
26
|
});
|
|
529
27
|
|
|
28
|
+
export const createUserBodyIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
29
|
+
|
|
530
30
|
export const CreateUserBody = zod
|
|
531
|
-
.
|
|
31
|
+
.object({
|
|
32
|
+
id: zod.string().regex(createUserBodyIdRegExp).optional(),
|
|
33
|
+
metadata: zod
|
|
34
|
+
.object({
|
|
35
|
+
created_at: zod.iso
|
|
36
|
+
.datetime({ offset: true })
|
|
37
|
+
.describe("The time when the user was created."),
|
|
38
|
+
updated_at: zod.iso
|
|
39
|
+
.datetime({ offset: true })
|
|
40
|
+
.describe("The time when the user was last updated."),
|
|
41
|
+
status: zod
|
|
42
|
+
.enum(["active", "suspended", "deactivated", "pending_purge"])
|
|
43
|
+
.describe("The status of the user."),
|
|
44
|
+
lifecycle_owner_team_id: zod
|
|
45
|
+
.union([zod.string(), zod.null()])
|
|
46
|
+
.optional()
|
|
47
|
+
.describe(
|
|
48
|
+
"The team that owns this user's identity lifecycle, or `null` when the\nuser is self-owned. This is a single team and a different concept from\nthe user's team roster: it decides who may deprovision the user, not\nwhich teams the user collaborates in. The roster is its own paginated\nresource — `GET \/users\/{user_id}\/teams`.\n",
|
|
49
|
+
),
|
|
50
|
+
})
|
|
51
|
+
.optional(),
|
|
52
|
+
})
|
|
532
53
|
.describe(
|
|
533
|
-
"A user represents an individual identity in the system. It can be used to \nrepresent a human user, but also a service account or any other type of \nidentity. The content of a user is determined by the configured schema for \nusers, this is only a base schema.\n",
|
|
54
|
+
"A user represents an individual identity in the system. It can be used to \nrepresent a human user, but also a service account or any other type of \nidentity. The content of a user is determined by the configured schema for \nusers, this is only a base schema.\n\nThe server assigns the resource primary key (`id`) on create. Clients must\nnot send `id` in the create body; it is returned in the create response.\n",
|
|
534
55
|
);
|
|
535
56
|
|
|
536
57
|
/**
|
|
537
58
|
* @summary List users
|
|
538
59
|
*/
|
|
539
|
-
export const listUsersQueryOffsetDefault = 0;
|
|
540
|
-
export const listUsersQueryOffsetMin = 0;
|
|
541
|
-
|
|
542
60
|
export const listUsersQueryLimitDefault = 20;
|
|
543
61
|
export const listUsersQueryLimitMax = 100;
|
|
544
62
|
|
|
545
63
|
export const ListUsersQueryParams = zod.strictObject({
|
|
546
|
-
offset: zod
|
|
547
|
-
.number()
|
|
548
|
-
.min(listUsersQueryOffsetMin)
|
|
549
|
-
.default(listUsersQueryOffsetDefault)
|
|
550
|
-
.describe("Number of items to skip before returning results."),
|
|
551
64
|
limit: zod
|
|
552
65
|
.number()
|
|
553
66
|
.min(1)
|
|
554
67
|
.max(listUsersQueryLimitMax)
|
|
555
68
|
.default(listUsersQueryLimitDefault)
|
|
556
69
|
.describe("Maximum number of items to return."),
|
|
70
|
+
page_token: zod
|
|
71
|
+
.string()
|
|
72
|
+
.optional()
|
|
73
|
+
.describe(
|
|
74
|
+
"Token for fetching the next page of results.\nObtain this value from `next_page_token` in the previous response.\nOmit to start from the beginning.\nIts format is opaque and may change between releases.\n",
|
|
75
|
+
),
|
|
557
76
|
});
|
|
558
77
|
|
|
559
|
-
export const
|
|
560
|
-
|
|
78
|
+
export const listUsersResponseUsersItemIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
79
|
+
|
|
80
|
+
export const ListUsersResponse = zod
|
|
81
|
+
.object({
|
|
82
|
+
users: zod.array(
|
|
83
|
+
zod
|
|
84
|
+
.object({
|
|
85
|
+
id: zod.string().regex(listUsersResponseUsersItemIdRegExp).optional(),
|
|
86
|
+
metadata: zod
|
|
87
|
+
.object({
|
|
88
|
+
created_at: zod.iso
|
|
89
|
+
.datetime({ offset: true })
|
|
90
|
+
.describe("The time when the user was created."),
|
|
91
|
+
updated_at: zod.iso
|
|
92
|
+
.datetime({ offset: true })
|
|
93
|
+
.describe("The time when the user was last updated."),
|
|
94
|
+
status: zod
|
|
95
|
+
.enum(["active", "suspended", "deactivated", "pending_purge"])
|
|
96
|
+
.describe("The status of the user."),
|
|
97
|
+
lifecycle_owner_team_id: zod
|
|
98
|
+
.union([zod.string(), zod.null()])
|
|
99
|
+
.optional()
|
|
100
|
+
.describe(
|
|
101
|
+
"The team that owns this user's identity lifecycle, or `null` when the\nuser is self-owned. This is a single team and a different concept from\nthe user's team roster: it decides who may deprovision the user, not\nwhich teams the user collaborates in. The roster is its own paginated\nresource — `GET \/users\/{user_id}\/teams`.\n",
|
|
102
|
+
),
|
|
103
|
+
})
|
|
104
|
+
.optional(),
|
|
105
|
+
})
|
|
106
|
+
.describe(
|
|
107
|
+
"A user represents an individual identity in the system. It can be used to \nrepresent a human user, but also a service account or any other type of \nidentity. The content of a user is determined by the configured schema for \nusers, this is only a base schema.\n\nThe server assigns the resource primary key (`id`) on create. Clients must\nnot send `id` in the create body; it is returned in the create response.\n",
|
|
108
|
+
),
|
|
109
|
+
),
|
|
110
|
+
next_page_token: zod
|
|
111
|
+
.union([zod.string(), zod.null()])
|
|
112
|
+
.optional()
|
|
113
|
+
.describe(
|
|
114
|
+
"Token to pass as `page_token` in the next request to fetch the following page.\nAbsent when there are no more results.\n",
|
|
115
|
+
),
|
|
116
|
+
})
|
|
117
|
+
.describe("Paginated list of users.");
|
|
561
118
|
|
|
562
119
|
/**
|
|
563
120
|
* @summary Get user by ID
|
|
@@ -583,7 +140,105 @@ export const GetUserByIDQueryParams = zod.strictObject({
|
|
|
583
140
|
.describe("The unique identifier of the team"),
|
|
584
141
|
});
|
|
585
142
|
|
|
586
|
-
export const
|
|
143
|
+
export const getUserByIDResponseIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
144
|
+
|
|
145
|
+
export const GetUserByIDResponse = zod
|
|
146
|
+
.object({
|
|
147
|
+
id: zod.string().regex(getUserByIDResponseIdRegExp).optional(),
|
|
148
|
+
metadata: zod
|
|
149
|
+
.object({
|
|
150
|
+
created_at: zod.iso
|
|
151
|
+
.datetime({ offset: true })
|
|
152
|
+
.describe("The time when the user was created."),
|
|
153
|
+
updated_at: zod.iso
|
|
154
|
+
.datetime({ offset: true })
|
|
155
|
+
.describe("The time when the user was last updated."),
|
|
156
|
+
status: zod
|
|
157
|
+
.enum(["active", "suspended", "deactivated", "pending_purge"])
|
|
158
|
+
.describe("The status of the user."),
|
|
159
|
+
lifecycle_owner_team_id: zod
|
|
160
|
+
.union([zod.string(), zod.null()])
|
|
161
|
+
.optional()
|
|
162
|
+
.describe(
|
|
163
|
+
"The team that owns this user's identity lifecycle, or `null` when the\nuser is self-owned. This is a single team and a different concept from\nthe user's team roster: it decides who may deprovision the user, not\nwhich teams the user collaborates in. The roster is its own paginated\nresource — `GET \/users\/{user_id}\/teams`.\n",
|
|
164
|
+
),
|
|
165
|
+
})
|
|
166
|
+
.optional(),
|
|
167
|
+
})
|
|
168
|
+
.describe(
|
|
169
|
+
"A user represents an individual identity in the system. It can be used to \nrepresent a human user, but also a service account or any other type of \nidentity. The content of a user is determined by the configured schema for \nusers, this is only a base schema.\n\nThe server assigns the resource primary key (`id`) on create. Clients must\nnot send `id` in the create body; it is returned in the create response.\n",
|
|
170
|
+
);
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* @summary Delete user by ID
|
|
174
|
+
*/
|
|
175
|
+
export const deleteUserByIDPathUserIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
176
|
+
|
|
177
|
+
export const DeleteUserByIDParams = zod.object({
|
|
178
|
+
user_id: zod.string().regex(deleteUserByIDPathUserIdRegExp),
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
export const deleteUserByIDQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
182
|
+
|
|
183
|
+
export const DeleteUserByIDQueryParams = zod.strictObject({
|
|
184
|
+
project_id: zod
|
|
185
|
+
.string()
|
|
186
|
+
.regex(deleteUserByIDQueryProjectIdRegExp)
|
|
187
|
+
.describe("The unique identifier of the project"),
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* @summary List user passkeys
|
|
192
|
+
*/
|
|
193
|
+
export const listUserPasskeysPathUserIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
194
|
+
|
|
195
|
+
export const ListUserPasskeysParams = zod.object({
|
|
196
|
+
user_id: zod.string().regex(listUserPasskeysPathUserIdRegExp),
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
export const listUserPasskeysQueryLimitDefault = 20;
|
|
200
|
+
export const listUserPasskeysQueryLimitMax = 100;
|
|
201
|
+
|
|
202
|
+
export const listUserPasskeysQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
203
|
+
|
|
204
|
+
export const ListUserPasskeysQueryParams = zod.strictObject({
|
|
205
|
+
limit: zod
|
|
206
|
+
.number()
|
|
207
|
+
.min(1)
|
|
208
|
+
.max(listUserPasskeysQueryLimitMax)
|
|
209
|
+
.default(listUserPasskeysQueryLimitDefault)
|
|
210
|
+
.describe("Maximum number of items to return."),
|
|
211
|
+
page_token: zod
|
|
212
|
+
.string()
|
|
213
|
+
.optional()
|
|
214
|
+
.describe(
|
|
215
|
+
"Token for fetching the next page of results.\nObtain this value from `next_page_token` in the previous response.\nOmit to start from the beginning.\nIts format is opaque and may change between releases.\n",
|
|
216
|
+
),
|
|
217
|
+
project_id: zod
|
|
218
|
+
.string()
|
|
219
|
+
.regex(listUserPasskeysQueryProjectIdRegExp)
|
|
220
|
+
.describe("The unique identifier of the project"),
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
export const ListUserPasskeysResponse = zod
|
|
224
|
+
.object({
|
|
225
|
+
passkeys: zod.array(
|
|
226
|
+
zod.object({
|
|
227
|
+
id: zod.string().describe("The unique identifier of the passkey."),
|
|
228
|
+
name: zod.string().describe("The name of the passkey."),
|
|
229
|
+
created_at: zod.iso
|
|
230
|
+
.datetime({ offset: true })
|
|
231
|
+
.describe("The timestamp when the passkey was created."),
|
|
232
|
+
}),
|
|
233
|
+
),
|
|
234
|
+
next_page_token: zod
|
|
235
|
+
.union([zod.string(), zod.null()])
|
|
236
|
+
.optional()
|
|
237
|
+
.describe(
|
|
238
|
+
"Token to pass as `page_token` in the next request to fetch the following page.\nAbsent when there are no more results.\n",
|
|
239
|
+
),
|
|
240
|
+
})
|
|
241
|
+
.describe("Response containing the user's passkeys.");
|
|
587
242
|
|
|
588
243
|
/**
|
|
589
244
|
* @summary Set user password
|
|
@@ -606,7 +261,7 @@ export const SetUserPasswordQueryParams = zod.strictObject({
|
|
|
606
261
|
export const SetUserPasswordBody = zod
|
|
607
262
|
.object({
|
|
608
263
|
password: zod.string().describe("The new password for the user."),
|
|
609
|
-
|
|
264
|
+
is_change_required: zod
|
|
610
265
|
.boolean()
|
|
611
266
|
.optional()
|
|
612
267
|
.describe(
|
|
@@ -615,10 +270,110 @@ export const SetUserPasswordBody = zod
|
|
|
615
270
|
})
|
|
616
271
|
.describe("Request to update the user's password.");
|
|
617
272
|
|
|
273
|
+
/**
|
|
274
|
+
* The user's team roster, ordered by team name. Each entry carries the
|
|
275
|
+
team's name, so a client renders a page without resolving ids one by one.
|
|
276
|
+
|
|
277
|
+
This is the N:N roster and it is not lifecycle ownership: the single team
|
|
278
|
+
that owns the user's lifecycle is reported as `metadata.lifecycle_owner_team_id`
|
|
279
|
+
on the user read endpoints. Memberships the user was removed from are not
|
|
280
|
+
returned.
|
|
281
|
+
|
|
282
|
+
* @summary List the teams a user belongs to
|
|
283
|
+
*/
|
|
284
|
+
export const listUserTeamsPathUserIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
285
|
+
|
|
286
|
+
export const ListUserTeamsParams = zod.object({
|
|
287
|
+
user_id: zod.string().regex(listUserTeamsPathUserIdRegExp),
|
|
288
|
+
});
|
|
289
|
+
|
|
290
|
+
export const listUserTeamsQueryLimitDefault = 20;
|
|
291
|
+
export const listUserTeamsQueryLimitMax = 100;
|
|
292
|
+
|
|
293
|
+
export const listUserTeamsQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
294
|
+
|
|
295
|
+
export const ListUserTeamsQueryParams = zod.strictObject({
|
|
296
|
+
limit: zod
|
|
297
|
+
.number()
|
|
298
|
+
.min(1)
|
|
299
|
+
.max(listUserTeamsQueryLimitMax)
|
|
300
|
+
.default(listUserTeamsQueryLimitDefault)
|
|
301
|
+
.describe("Maximum number of items to return."),
|
|
302
|
+
page_token: zod
|
|
303
|
+
.string()
|
|
304
|
+
.optional()
|
|
305
|
+
.describe(
|
|
306
|
+
"Token for fetching the next page of results.\nObtain this value from `next_page_token` in the previous response.\nOmit to start from the beginning.\nIts format is opaque and may change between releases.\n",
|
|
307
|
+
),
|
|
308
|
+
project_id: zod
|
|
309
|
+
.string()
|
|
310
|
+
.regex(listUserTeamsQueryProjectIdRegExp)
|
|
311
|
+
.describe("The unique identifier of the project"),
|
|
312
|
+
});
|
|
313
|
+
|
|
314
|
+
export const ListUserTeamsResponse = zod
|
|
315
|
+
.object({
|
|
316
|
+
teams: zod.array(
|
|
317
|
+
zod
|
|
318
|
+
.object({
|
|
319
|
+
id: zod.string().describe("The unique identifier of the team."),
|
|
320
|
+
name: zod.string().describe("The name of the team."),
|
|
321
|
+
membership_status: zod
|
|
322
|
+
.enum(["pending", "active", "inactive"])
|
|
323
|
+
.describe(
|
|
324
|
+
"The user's participation state on this team. Memberships the user was\nremoved from are not returned.\n",
|
|
325
|
+
),
|
|
326
|
+
created_at: zod.iso
|
|
327
|
+
.datetime({ offset: true })
|
|
328
|
+
.describe("The time when the user joined this team."),
|
|
329
|
+
updated_at: zod.iso
|
|
330
|
+
.datetime({ offset: true })
|
|
331
|
+
.describe("The time when this membership was last changed."),
|
|
332
|
+
})
|
|
333
|
+
.describe(
|
|
334
|
+
"One entry of a user's team roster: a team the user belongs to, with the\nmembership's participation state. The team's `name` travels with the entry, so\na page renders without a follow-up `POST \/teams\/query` per row.\n\nRoster membership is not lifecycle ownership. A user can belong to many teams\nwhile still owning their own lifecycle — that single owning team is reported\nas `metadata.lifecycle_owner_team_id` on the user itself.\n",
|
|
335
|
+
),
|
|
336
|
+
),
|
|
337
|
+
next_page_token: zod
|
|
338
|
+
.union([zod.string(), zod.null()])
|
|
339
|
+
.optional()
|
|
340
|
+
.describe(
|
|
341
|
+
"Token to pass as `page_token` in the next request to fetch the following page.\nAbsent when there are no more results.\n",
|
|
342
|
+
),
|
|
343
|
+
})
|
|
344
|
+
.describe("Paginated list of the teams a user belongs to.");
|
|
345
|
+
|
|
618
346
|
/**
|
|
619
347
|
* @summary Get my user information
|
|
620
348
|
*/
|
|
621
|
-
export const
|
|
349
|
+
export const getMyUserResponseIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
350
|
+
|
|
351
|
+
export const GetMyUserResponse = zod
|
|
352
|
+
.object({
|
|
353
|
+
id: zod.string().regex(getMyUserResponseIdRegExp).optional(),
|
|
354
|
+
metadata: zod
|
|
355
|
+
.object({
|
|
356
|
+
created_at: zod.iso
|
|
357
|
+
.datetime({ offset: true })
|
|
358
|
+
.describe("The time when the user was created."),
|
|
359
|
+
updated_at: zod.iso
|
|
360
|
+
.datetime({ offset: true })
|
|
361
|
+
.describe("The time when the user was last updated."),
|
|
362
|
+
status: zod
|
|
363
|
+
.enum(["active", "suspended", "deactivated", "pending_purge"])
|
|
364
|
+
.describe("The status of the user."),
|
|
365
|
+
lifecycle_owner_team_id: zod
|
|
366
|
+
.union([zod.string(), zod.null()])
|
|
367
|
+
.optional()
|
|
368
|
+
.describe(
|
|
369
|
+
"The team that owns this user's identity lifecycle, or `null` when the\nuser is self-owned. This is a single team and a different concept from\nthe user's team roster: it decides who may deprovision the user, not\nwhich teams the user collaborates in. The roster is its own paginated\nresource — `GET \/users\/{user_id}\/teams`.\n",
|
|
370
|
+
),
|
|
371
|
+
})
|
|
372
|
+
.optional(),
|
|
373
|
+
})
|
|
374
|
+
.describe(
|
|
375
|
+
"A user represents an individual identity in the system. It can be used to \nrepresent a human user, but also a service account or any other type of \nidentity. The content of a user is determined by the configured schema for \nusers, this is only a base schema.\n\nThe server assigns the resource primary key (`id`) on create. Clients must\nnot send `id` in the create body; it is returned in the create response.\n",
|
|
376
|
+
);
|
|
622
377
|
|
|
623
378
|
/**
|
|
624
379
|
* Resolves a flow definition based on purpose + audience context and returns
|
|
@@ -626,7 +381,7 @@ the first capability step. Creates a new session implicitly unless
|
|
|
626
381
|
`session_id` is provided (for step-up / reauth on an existing session).
|
|
627
382
|
|
|
628
383
|
The response contains an `id` field — the flow handle. Use it as the path
|
|
629
|
-
parameter for all subsequent `/flow/{id}/submit`
|
|
384
|
+
parameter for all subsequent `/flow/{id}/submit` calls.
|
|
630
385
|
|
|
631
386
|
The response also sets an encrypted `HttpOnly` cookie (`_zflow`) containing
|
|
632
387
|
the flow's orchestration state (current step, collected data, history).
|
|
@@ -718,6 +473,7 @@ export const getFlowStepResponseStepActionsDefault = [];
|
|
|
718
473
|
export const getFlowStepResponseStepGatesDefault = {} as const;
|
|
719
474
|
export const getFlowStepResponseStepSsoProvidersDefault = [];
|
|
720
475
|
export const getFlowStepResponseBrandingLayoutDefault = `centered`;
|
|
476
|
+
export const getFlowStepResponseBrandingLiquidTemplateMax = 131072;
|
|
721
477
|
|
|
722
478
|
export const GetFlowStepResponse = zod.object({
|
|
723
479
|
id: zod
|
|
@@ -751,7 +507,7 @@ export const GetFlowStepResponse = zod.object({
|
|
|
751
507
|
.union([zod.string(), zod.null()])
|
|
752
508
|
.optional()
|
|
753
509
|
.describe(
|
|
754
|
-
'Error from a previous failed submission. Field-validation failures\ncarry localisation text keys: `error.<field>_<rule>` per violation\n(e.g. `error.email_required`; the `format` rule is spelled\n`error.<field>_invalid`), multiple violations joined with `\"; \"`.\nField names appear verbatim, so clients localise unknown keys via\nthe generic `error.field_<rule>` catalog entries. Other
|
|
510
|
+
'Error from a previous failed submission. Field-validation failures\ncarry localisation text keys: `error.<field>_<rule>` per violation\n(e.g. `error.email_required`; the `format` rule is spelled\n`error.<field>_invalid`), multiple violations joined with `\"; \"`.\nField names appear verbatim, so clients localise unknown keys via\nthe generic `error.field_<rule>` catalog entries. Other engine\nfailures carry `error.\*` catalog keys as well (e.g.\n`error.invalid_credentials`, `error.passkey_invalid`); a\nnon-`error.` payload is an outcome token (e.g. `user_not_found`)\nthat clients keep verbatim.\n',
|
|
755
511
|
),
|
|
756
512
|
complete: zod
|
|
757
513
|
.enum(["redirect", "show"])
|
|
@@ -945,21 +701,27 @@ export const GetFlowStepResponse = zod.object({
|
|
|
945
701
|
.enum(["centered", "split"])
|
|
946
702
|
.default(getFlowStepResponseBrandingLayoutDefault)
|
|
947
703
|
.describe(
|
|
948
|
-
"Layout preset selector. The default.liquid master template uses this\nto branch into layout variants. Customers who eject the template\ncan ignore this field entirely.\n",
|
|
704
|
+
"Layout preset selector. The default.liquid master template uses this\nto branch into layout variants. Customers who eject the template\ncan ignore this field entirely; it also serves as the degrade target\nwhen a custom template fails component-side validation.\n",
|
|
949
705
|
),
|
|
950
706
|
liquid_template: zod
|
|
951
707
|
.string()
|
|
708
|
+
.max(getFlowStepResponseBrandingLiquidTemplateMax)
|
|
952
709
|
.optional()
|
|
953
710
|
.describe(
|
|
954
711
|
"The LiquidJS template string for rendering this step. The orchestrator\nparses this template, injects the capability dictionaries as context,\nand renders the output HTML into its Shadow DOM.\n",
|
|
955
712
|
),
|
|
956
713
|
logo_url: zod.url().optional().describe("Team logo URL."),
|
|
957
|
-
font_url: zod
|
|
714
|
+
font_url: zod
|
|
715
|
+
.url()
|
|
716
|
+
.optional()
|
|
717
|
+
.describe(
|
|
718
|
+
"Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in\nv1: `POST \/branding` rejects a non-empty value, because the login\ncomponent loads this stylesheet at document level (shadow-scoped\n`@font-face` rules never register faces) and an arbitrary URL would\ngrant `branding.write` page-wide CSS control over the embedding\napplication. Safe tenant font delivery is an ADR 040 follow-up;\nuntil then, load fonts from the embedding page.\n",
|
|
719
|
+
),
|
|
958
720
|
hero_url: zod.url().optional().describe("Hero\/background image URL (used by split layout)."),
|
|
959
721
|
})
|
|
960
722
|
.optional()
|
|
961
723
|
.describe(
|
|
962
|
-
"
|
|
724
|
+
"Branding configuration. Appears in two places with one shape:\n\n- On flow responses as a read-only projection: the server resolves the\n latest branding revision for the project per step response (falling\n back to built-in defaults when none is stored). Branding is configured\n via the Branding API \/ `zitadel apply`, not the Flow API.\n- As the request body of `POST \/branding`, which publishes the same\n shape as a new immutable revision (see ADR 040).\n",
|
|
963
725
|
),
|
|
964
726
|
redirect_uri: zod.url().optional().describe("Present when `step.complete` is `redirect`."),
|
|
965
727
|
handoff_token: zod
|
|
@@ -1086,6 +848,7 @@ export const submitFlowStepResponseStepActionsDefault = [];
|
|
|
1086
848
|
export const submitFlowStepResponseStepGatesDefault = {} as const;
|
|
1087
849
|
export const submitFlowStepResponseStepSsoProvidersDefault = [];
|
|
1088
850
|
export const submitFlowStepResponseBrandingLayoutDefault = `centered`;
|
|
851
|
+
export const submitFlowStepResponseBrandingLiquidTemplateMax = 131072;
|
|
1089
852
|
|
|
1090
853
|
export const SubmitFlowStepResponse = zod.object({
|
|
1091
854
|
id: zod
|
|
@@ -1119,7 +882,7 @@ export const SubmitFlowStepResponse = zod.object({
|
|
|
1119
882
|
.union([zod.string(), zod.null()])
|
|
1120
883
|
.optional()
|
|
1121
884
|
.describe(
|
|
1122
|
-
'Error from a previous failed submission. Field-validation failures\ncarry localisation text keys: `error.<field>_<rule>` per violation\n(e.g. `error.email_required`; the `format` rule is spelled\n`error.<field>_invalid`), multiple violations joined with `\"; \"`.\nField names appear verbatim, so clients localise unknown keys via\nthe generic `error.field_<rule>` catalog entries. Other
|
|
885
|
+
'Error from a previous failed submission. Field-validation failures\ncarry localisation text keys: `error.<field>_<rule>` per violation\n(e.g. `error.email_required`; the `format` rule is spelled\n`error.<field>_invalid`), multiple violations joined with `\"; \"`.\nField names appear verbatim, so clients localise unknown keys via\nthe generic `error.field_<rule>` catalog entries. Other engine\nfailures carry `error.\*` catalog keys as well (e.g.\n`error.invalid_credentials`, `error.passkey_invalid`); a\nnon-`error.` payload is an outcome token (e.g. `user_not_found`)\nthat clients keep verbatim.\n',
|
|
1123
886
|
),
|
|
1124
887
|
complete: zod
|
|
1125
888
|
.enum(["redirect", "show"])
|
|
@@ -1313,21 +1076,27 @@ export const SubmitFlowStepResponse = zod.object({
|
|
|
1313
1076
|
.enum(["centered", "split"])
|
|
1314
1077
|
.default(submitFlowStepResponseBrandingLayoutDefault)
|
|
1315
1078
|
.describe(
|
|
1316
|
-
"Layout preset selector. The default.liquid master template uses this\nto branch into layout variants. Customers who eject the template\ncan ignore this field entirely.\n",
|
|
1079
|
+
"Layout preset selector. The default.liquid master template uses this\nto branch into layout variants. Customers who eject the template\ncan ignore this field entirely; it also serves as the degrade target\nwhen a custom template fails component-side validation.\n",
|
|
1317
1080
|
),
|
|
1318
1081
|
liquid_template: zod
|
|
1319
1082
|
.string()
|
|
1083
|
+
.max(submitFlowStepResponseBrandingLiquidTemplateMax)
|
|
1320
1084
|
.optional()
|
|
1321
1085
|
.describe(
|
|
1322
1086
|
"The LiquidJS template string for rendering this step. The orchestrator\nparses this template, injects the capability dictionaries as context,\nand renders the output HTML into its Shadow DOM.\n",
|
|
1323
1087
|
),
|
|
1324
1088
|
logo_url: zod.url().optional().describe("Team logo URL."),
|
|
1325
|
-
font_url: zod
|
|
1089
|
+
font_url: zod
|
|
1090
|
+
.url()
|
|
1091
|
+
.optional()
|
|
1092
|
+
.describe(
|
|
1093
|
+
"Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in\nv1: `POST \/branding` rejects a non-empty value, because the login\ncomponent loads this stylesheet at document level (shadow-scoped\n`@font-face` rules never register faces) and an arbitrary URL would\ngrant `branding.write` page-wide CSS control over the embedding\napplication. Safe tenant font delivery is an ADR 040 follow-up;\nuntil then, load fonts from the embedding page.\n",
|
|
1094
|
+
),
|
|
1326
1095
|
hero_url: zod.url().optional().describe("Hero\/background image URL (used by split layout)."),
|
|
1327
1096
|
})
|
|
1328
1097
|
.optional()
|
|
1329
1098
|
.describe(
|
|
1330
|
-
"
|
|
1099
|
+
"Branding configuration. Appears in two places with one shape:\n\n- On flow responses as a read-only projection: the server resolves the\n latest branding revision for the project per step response (falling\n back to built-in defaults when none is stored). Branding is configured\n via the Branding API \/ `zitadel apply`, not the Flow API.\n- As the request body of `POST \/branding`, which publishes the same\n shape as a new immutable revision (see ADR 040).\n",
|
|
1331
1100
|
),
|
|
1332
1101
|
redirect_uri: zod.url().optional().describe("Present when `step.complete` is `redirect`."),
|
|
1333
1102
|
handoff_token: zod
|
|
@@ -1342,34 +1111,6 @@ export const SubmitFlowStepResponse = zod.object({
|
|
|
1342
1111
|
.describe("Expiry timestamp for `handoff_token`. Only present when\n`handoff_token` is set.\n"),
|
|
1343
1112
|
});
|
|
1344
1113
|
|
|
1345
|
-
/**
|
|
1346
|
-
* Submits telemetry or fingerprint data from the frontend.
|
|
1347
|
-
Does not advance the state machine. Used for risk evaluation.
|
|
1348
|
-
|
|
1349
|
-
* @summary Submit client-side event
|
|
1350
|
-
*/
|
|
1351
|
-
export const SubmitFlowEventParams = zod.object({
|
|
1352
|
-
id: zod
|
|
1353
|
-
.string()
|
|
1354
|
-
.describe(
|
|
1355
|
-
"Flow ID returned by POST \/flow or the latest POST \/flow\/{id}\/submit.\nUsed to look up the correct flow state from the encrypted cookie,\nwhich can hold multiple concurrent flows. May change between responses\nwhen a flow pivot or pop occurs — always use the `id` from the latest response.\n",
|
|
1356
|
-
),
|
|
1357
|
-
});
|
|
1358
|
-
|
|
1359
|
-
export const SubmitFlowEventBody = zod.object({
|
|
1360
|
-
session_token: zod
|
|
1361
|
-
.string()
|
|
1362
|
-
.optional()
|
|
1363
|
-
.describe(
|
|
1364
|
-
"Reserved for future rotation. The sealed `_zflow` cookie carries the flow state today.",
|
|
1365
|
-
),
|
|
1366
|
-
type: zod.enum(["fingerprint", "telemetry"]),
|
|
1367
|
-
payload: zod
|
|
1368
|
-
.record(zod.string(), zod.unknown())
|
|
1369
|
-
.optional()
|
|
1370
|
-
.describe("Event payload (fingerprint hash, timing data, etc.)."),
|
|
1371
|
-
});
|
|
1372
|
-
|
|
1373
1114
|
/**
|
|
1374
1115
|
* Starts a new authentication attempt. This is the entry point for the auth_attempts state machine.
|
|
1375
1116
|
|
|
@@ -1382,7 +1123,7 @@ also include session_id to add factors to an existing session.
|
|
|
1382
1123
|
* @summary Create a new authentication attempt
|
|
1383
1124
|
*/
|
|
1384
1125
|
export const createAuthAttemptBodyProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1385
|
-
export const createAuthAttemptBodySessionIdOneRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1126
|
+
export const createAuthAttemptBodySessionIdOneRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
1386
1127
|
|
|
1387
1128
|
export const CreateAuthAttemptBody = zod
|
|
1388
1129
|
.object({
|
|
@@ -1398,7 +1139,7 @@ export const CreateAuthAttemptBody = zod
|
|
|
1398
1139
|
zod
|
|
1399
1140
|
.string()
|
|
1400
1141
|
.regex(createAuthAttemptBodySessionIdOneRegExp)
|
|
1401
|
-
.describe("Unique identifier for this session."),
|
|
1142
|
+
.describe("Unique identifier for this session (dialect-minted prefixed opaque string)."),
|
|
1402
1143
|
zod.null(),
|
|
1403
1144
|
])
|
|
1404
1145
|
.optional()
|
|
@@ -1419,7 +1160,7 @@ a federated IdP callback or a device flow).
|
|
|
1419
1160
|
|
|
1420
1161
|
* @summary Get authentication attempt state
|
|
1421
1162
|
*/
|
|
1422
|
-
export const getAuthAttemptPathAttemptIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1163
|
+
export const getAuthAttemptPathAttemptIdRegExp = new RegExp("^att_[a-zA-Z0-9_-]+$");
|
|
1423
1164
|
|
|
1424
1165
|
export const GetAuthAttemptParams = zod.object({
|
|
1425
1166
|
attempt_id: zod
|
|
@@ -1428,21 +1169,25 @@ export const GetAuthAttemptParams = zod.object({
|
|
|
1428
1169
|
.describe("The unique identifier of the authentication attempt"),
|
|
1429
1170
|
});
|
|
1430
1171
|
|
|
1431
|
-
export const getAuthAttemptResponseAttemptIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1172
|
+
export const getAuthAttemptResponseAttemptIdRegExp = new RegExp("^att_[a-zA-Z0-9_-]+$");
|
|
1432
1173
|
export const getAuthAttemptResponseProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1433
|
-
export const getAuthAttemptResponseSessionIdOneRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1174
|
+
export const getAuthAttemptResponseSessionIdOneRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
1434
1175
|
export const getAuthAttemptResponseUserIdOneRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
1435
1176
|
export const getAuthAttemptResponseCompletedFactorsItemPayloadOneUserIdRegExp = new RegExp(
|
|
1436
1177
|
"^user_[a-zA-Z0-9_-]+$",
|
|
1437
1178
|
);
|
|
1438
|
-
export const getAuthAttemptResponseChallengesItemChallengeIdRegExp = new RegExp(
|
|
1179
|
+
export const getAuthAttemptResponseChallengesItemChallengeIdRegExp = new RegExp(
|
|
1180
|
+
"^ch_[a-zA-Z0-9_-]+$",
|
|
1181
|
+
);
|
|
1439
1182
|
|
|
1440
1183
|
export const GetAuthAttemptResponse = zod
|
|
1441
1184
|
.object({
|
|
1442
1185
|
attempt_id: zod
|
|
1443
1186
|
.string()
|
|
1444
1187
|
.regex(getAuthAttemptResponseAttemptIdRegExp)
|
|
1445
|
-
.describe(
|
|
1188
|
+
.describe(
|
|
1189
|
+
"Unique identifier for this authentication attempt (dialect-minted prefixed opaque string).",
|
|
1190
|
+
),
|
|
1446
1191
|
project_id: zod.string().regex(getAuthAttemptResponseProjectIdRegExp),
|
|
1447
1192
|
state: zod
|
|
1448
1193
|
.enum(["in_progress", "completed", "failed", "expired"])
|
|
@@ -1454,7 +1199,7 @@ export const GetAuthAttemptResponse = zod
|
|
|
1454
1199
|
zod
|
|
1455
1200
|
.string()
|
|
1456
1201
|
.regex(getAuthAttemptResponseSessionIdOneRegExp)
|
|
1457
|
-
.describe("Unique identifier for this session."),
|
|
1202
|
+
.describe("Unique identifier for this session (dialect-minted prefixed opaque string)."),
|
|
1458
1203
|
zod.null(),
|
|
1459
1204
|
])
|
|
1460
1205
|
.optional()
|
|
@@ -1544,7 +1289,9 @@ export const GetAuthAttemptResponse = zod
|
|
|
1544
1289
|
challenge_id: zod
|
|
1545
1290
|
.string()
|
|
1546
1291
|
.regex(getAuthAttemptResponseChallengesItemChallengeIdRegExp)
|
|
1547
|
-
.describe(
|
|
1292
|
+
.describe(
|
|
1293
|
+
"Unique identifier for this challenge (dialect-minted prefixed opaque string).",
|
|
1294
|
+
),
|
|
1548
1295
|
method: zod
|
|
1549
1296
|
.enum(["identifier", "password", "passkey"])
|
|
1550
1297
|
.describe("An authentication factor method."),
|
|
@@ -1633,7 +1380,7 @@ by calling POST /auth_attempts/{attempt_id}/challenges/{challenge_id}/verify.
|
|
|
1633
1380
|
|
|
1634
1381
|
* @summary Issue a factor challenge
|
|
1635
1382
|
*/
|
|
1636
|
-
export const issueChallengePathAttemptIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1383
|
+
export const issueChallengePathAttemptIdRegExp = new RegExp("^att_[a-zA-Z0-9_-]+$");
|
|
1637
1384
|
|
|
1638
1385
|
export const IssueChallengeParams = zod.object({
|
|
1639
1386
|
attempt_id: zod
|
|
@@ -1684,8 +1431,8 @@ The attempt moves to the next pending challenge or completes if all required fac
|
|
|
1684
1431
|
|
|
1685
1432
|
* @summary Verify a factor proof
|
|
1686
1433
|
*/
|
|
1687
|
-
export const verifyChallengeProofPathAttemptIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1688
|
-
export const verifyChallengeProofPathChallengeIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1434
|
+
export const verifyChallengeProofPathAttemptIdRegExp = new RegExp("^att_[a-zA-Z0-9_-]+$");
|
|
1435
|
+
export const verifyChallengeProofPathChallengeIdRegExp = new RegExp("^ch_[a-zA-Z0-9_-]+$");
|
|
1689
1436
|
|
|
1690
1437
|
export const VerifyChallengeProofParams = zod.object({
|
|
1691
1438
|
attempt_id: zod
|
|
@@ -1735,15 +1482,15 @@ export const VerifyChallengeProofBody = zod
|
|
|
1735
1482
|
"Proof for verifying a factor challenge.\n\nThe exact format depends on the challenge method. The proof object should contain\nonly the credential\/code\/assertion relevant to the challenge method being verified.\n",
|
|
1736
1483
|
);
|
|
1737
1484
|
|
|
1738
|
-
export const verifyChallengeProofResponseAttemptIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1485
|
+
export const verifyChallengeProofResponseAttemptIdRegExp = new RegExp("^att_[a-zA-Z0-9_-]+$");
|
|
1739
1486
|
export const verifyChallengeProofResponseProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1740
|
-
export const verifyChallengeProofResponseSessionIdOneRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1487
|
+
export const verifyChallengeProofResponseSessionIdOneRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
1741
1488
|
export const verifyChallengeProofResponseUserIdOneRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
1742
1489
|
export const verifyChallengeProofResponseCompletedFactorsItemPayloadOneUserIdRegExp = new RegExp(
|
|
1743
1490
|
"^user_[a-zA-Z0-9_-]+$",
|
|
1744
1491
|
);
|
|
1745
1492
|
export const verifyChallengeProofResponseChallengesItemChallengeIdRegExp = new RegExp(
|
|
1746
|
-
"^[a-zA-Z0-9_-]+$",
|
|
1493
|
+
"^ch_[a-zA-Z0-9_-]+$",
|
|
1747
1494
|
);
|
|
1748
1495
|
|
|
1749
1496
|
export const VerifyChallengeProofResponse = zod
|
|
@@ -1751,7 +1498,9 @@ export const VerifyChallengeProofResponse = zod
|
|
|
1751
1498
|
attempt_id: zod
|
|
1752
1499
|
.string()
|
|
1753
1500
|
.regex(verifyChallengeProofResponseAttemptIdRegExp)
|
|
1754
|
-
.describe(
|
|
1501
|
+
.describe(
|
|
1502
|
+
"Unique identifier for this authentication attempt (dialect-minted prefixed opaque string).",
|
|
1503
|
+
),
|
|
1755
1504
|
project_id: zod.string().regex(verifyChallengeProofResponseProjectIdRegExp),
|
|
1756
1505
|
state: zod
|
|
1757
1506
|
.enum(["in_progress", "completed", "failed", "expired"])
|
|
@@ -1763,7 +1512,7 @@ export const VerifyChallengeProofResponse = zod
|
|
|
1763
1512
|
zod
|
|
1764
1513
|
.string()
|
|
1765
1514
|
.regex(verifyChallengeProofResponseSessionIdOneRegExp)
|
|
1766
|
-
.describe("Unique identifier for this session."),
|
|
1515
|
+
.describe("Unique identifier for this session (dialect-minted prefixed opaque string)."),
|
|
1767
1516
|
zod.null(),
|
|
1768
1517
|
])
|
|
1769
1518
|
.optional()
|
|
@@ -1855,7 +1604,9 @@ export const VerifyChallengeProofResponse = zod
|
|
|
1855
1604
|
challenge_id: zod
|
|
1856
1605
|
.string()
|
|
1857
1606
|
.regex(verifyChallengeProofResponseChallengesItemChallengeIdRegExp)
|
|
1858
|
-
.describe(
|
|
1607
|
+
.describe(
|
|
1608
|
+
"Unique identifier for this challenge (dialect-minted prefixed opaque string).",
|
|
1609
|
+
),
|
|
1859
1610
|
method: zod
|
|
1860
1611
|
.enum(["identifier", "password", "passkey"])
|
|
1861
1612
|
.describe("An authentication factor method."),
|
|
@@ -1948,7 +1699,7 @@ The handoff token is:
|
|
|
1948
1699
|
|
|
1949
1700
|
* @summary Complete authentication and create handoff token
|
|
1950
1701
|
*/
|
|
1951
|
-
export const createHandoffPathAttemptIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1702
|
+
export const createHandoffPathAttemptIdRegExp = new RegExp("^att_[a-zA-Z0-9_-]+$");
|
|
1952
1703
|
|
|
1953
1704
|
export const CreateHandoffParams = zod.object({
|
|
1954
1705
|
attempt_id: zod
|
|
@@ -1986,11 +1737,11 @@ export const createProjectBodySeedDefaultsDefault = true;
|
|
|
1986
1737
|
|
|
1987
1738
|
export const CreateProjectBody = zod.object({
|
|
1988
1739
|
name: zod.string().describe("The name of the project."),
|
|
1989
|
-
|
|
1740
|
+
preview_origins: zod
|
|
1990
1741
|
.array(zod.string())
|
|
1991
1742
|
.optional()
|
|
1992
1743
|
.describe("Origins which are allowed for previewing and testing the project.\n"),
|
|
1993
|
-
|
|
1744
|
+
seed_defaults: zod
|
|
1994
1745
|
.boolean()
|
|
1995
1746
|
.default(createProjectBodySeedDefaultsDefault)
|
|
1996
1747
|
.describe(
|
|
@@ -2014,17 +1765,19 @@ export const QueryProjectsBody = zod
|
|
|
2014
1765
|
page_token: zod
|
|
2015
1766
|
.union([zod.string(), zod.null()])
|
|
2016
1767
|
.optional()
|
|
2017
|
-
.describe(
|
|
1768
|
+
.describe(
|
|
1769
|
+
"Token to retrieve the next page of results. Must be sent with the same\n`sorting` as the request that issued the token. Omitting `sorting` reuses\nthe default sort and only succeeds when that default matches the token.\n",
|
|
1770
|
+
),
|
|
2018
1771
|
sorting: zod
|
|
2019
1772
|
.object({
|
|
2020
|
-
field: zod.enum(["
|
|
1773
|
+
field: zod.enum(["created_at"]),
|
|
2021
1774
|
direction: zod.enum(["asc", "desc"]),
|
|
2022
1775
|
})
|
|
2023
1776
|
.optional(),
|
|
2024
1777
|
filter: zod
|
|
2025
1778
|
.array(
|
|
2026
1779
|
zod.object({
|
|
2027
|
-
field: zod.enum(["
|
|
1780
|
+
field: zod.enum(["created_at"]),
|
|
2028
1781
|
value: zod
|
|
2029
1782
|
.union([zod.string(), zod.number(), zod.boolean(), zod.null()])
|
|
2030
1783
|
.optional()
|
|
@@ -2059,14 +1812,14 @@ export const QueryProjectsResponse = zod
|
|
|
2059
1812
|
.object({
|
|
2060
1813
|
id: zod.string().describe("The unique identifier of the project."),
|
|
2061
1814
|
name: zod.string().describe("The name of the project."),
|
|
2062
|
-
|
|
1815
|
+
preview_origins: zod
|
|
2063
1816
|
.array(zod.string())
|
|
2064
1817
|
.optional()
|
|
2065
1818
|
.describe("Origins which are allowed for previewing and testing the project.\n"),
|
|
2066
|
-
|
|
1819
|
+
created_at: zod.iso
|
|
2067
1820
|
.datetime({ offset: true })
|
|
2068
1821
|
.describe("The time when the project was created."),
|
|
2069
|
-
|
|
1822
|
+
updated_at: zod.iso
|
|
2070
1823
|
.datetime({ offset: true })
|
|
2071
1824
|
.describe("The time when the project was last updated."),
|
|
2072
1825
|
})
|
|
@@ -2076,7 +1829,7 @@ export const QueryProjectsResponse = zod
|
|
|
2076
1829
|
.union([zod.string(), zod.null()])
|
|
2077
1830
|
.optional()
|
|
2078
1831
|
.describe(
|
|
2079
|
-
"Token to pass as `page_token` in the next request to fetch the following page.\nAbsent when there are no more results.\n",
|
|
1832
|
+
"Token to pass as `page_token` in the next request to fetch the following page.\nAbsent when there are no more results. The follow-up request must repeat the\nsame `sorting` that produced this token (omit only when both pages use the default).\n",
|
|
2080
1833
|
),
|
|
2081
1834
|
})
|
|
2082
1835
|
.describe("Paginated list of projects.");
|
|
@@ -2096,14 +1849,14 @@ export const GetProjectResponse = zod
|
|
|
2096
1849
|
.object({
|
|
2097
1850
|
id: zod.string().describe("The unique identifier of the project."),
|
|
2098
1851
|
name: zod.string().describe("The name of the project."),
|
|
2099
|
-
|
|
1852
|
+
preview_origins: zod
|
|
2100
1853
|
.array(zod.string())
|
|
2101
1854
|
.optional()
|
|
2102
1855
|
.describe("Origins which are allowed for previewing and testing the project.\n"),
|
|
2103
|
-
|
|
1856
|
+
created_at: zod.iso
|
|
2104
1857
|
.datetime({ offset: true })
|
|
2105
1858
|
.describe("The time when the project was created."),
|
|
2106
|
-
|
|
1859
|
+
updated_at: zod.iso
|
|
2107
1860
|
.datetime({ offset: true })
|
|
2108
1861
|
.describe("The time when the project was last updated."),
|
|
2109
1862
|
})
|
|
@@ -2128,18 +1881,120 @@ export const PatchProjectResponse = zod
|
|
|
2128
1881
|
.object({
|
|
2129
1882
|
id: zod.string().describe("The unique identifier of the project."),
|
|
2130
1883
|
name: zod.string().describe("The name of the project."),
|
|
2131
|
-
|
|
1884
|
+
preview_origins: zod
|
|
2132
1885
|
.array(zod.string())
|
|
2133
1886
|
.optional()
|
|
2134
1887
|
.describe("Origins which are allowed for previewing and testing the project.\n"),
|
|
2135
|
-
|
|
1888
|
+
created_at: zod.iso
|
|
2136
1889
|
.datetime({ offset: true })
|
|
2137
1890
|
.describe("The time when the project was created."),
|
|
2138
|
-
|
|
1891
|
+
updated_at: zod.iso
|
|
2139
1892
|
.datetime({ offset: true })
|
|
2140
1893
|
.describe("The time when the project was last updated."),
|
|
2141
1894
|
})
|
|
2142
|
-
.describe("The current state of a project.");
|
|
1895
|
+
.describe("The current state of a project.");
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* Starts a claim challenge for an unclaimed project. Authenticated by the
|
|
1899
|
+
project secret, this mints a single-use, short-lived challenge and returns
|
|
1900
|
+
the `claim_url` the developer opens in a browser to complete the claim,
|
|
1901
|
+
together with the `challenge_id` the CLI polls with. The exact expiry is
|
|
1902
|
+
carried by `expires_at` on the response.
|
|
1903
|
+
|
|
1904
|
+
* @summary Initialize a project claim
|
|
1905
|
+
*/
|
|
1906
|
+
export const initClaimPathProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1907
|
+
|
|
1908
|
+
export const InitClaimParams = zod.object({
|
|
1909
|
+
project_id: zod.string().regex(initClaimPathProjectIdRegExp),
|
|
1910
|
+
});
|
|
1911
|
+
|
|
1912
|
+
/**
|
|
1913
|
+
* Polled by the CLI while a browser completes the claim. Authorized by the
|
|
1914
|
+
project secret that initiated the challenge. Returns `pending`, or
|
|
1915
|
+
`completed` with the owning team, the claim timestamp, and the dashboard
|
|
1916
|
+
URL once the browser leg has finished.
|
|
1917
|
+
|
|
1918
|
+
* @summary Get claim status
|
|
1919
|
+
*/
|
|
1920
|
+
export const getClaimStatusPathProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1921
|
+
|
|
1922
|
+
export const GetClaimStatusParams = zod.object({
|
|
1923
|
+
project_id: zod.string().regex(getClaimStatusPathProjectIdRegExp),
|
|
1924
|
+
});
|
|
1925
|
+
|
|
1926
|
+
export const getClaimStatusQueryChallengeIdRegExp = new RegExp("^ch_[a-zA-Z0-9_-]+$");
|
|
1927
|
+
|
|
1928
|
+
export const GetClaimStatusQueryParams = zod.strictObject({
|
|
1929
|
+
challenge_id: zod
|
|
1930
|
+
.string()
|
|
1931
|
+
.regex(getClaimStatusQueryChallengeIdRegExp)
|
|
1932
|
+
.describe("The challenge minted by the matching claim init."),
|
|
1933
|
+
});
|
|
1934
|
+
|
|
1935
|
+
export const getClaimStatusResponseTwoTeamIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1936
|
+
|
|
1937
|
+
export const GetClaimStatusResponse = zod
|
|
1938
|
+
.union([
|
|
1939
|
+
zod
|
|
1940
|
+
.object({
|
|
1941
|
+
status: zod.enum(["pending"]).describe("The claim has not completed yet."),
|
|
1942
|
+
})
|
|
1943
|
+
.describe("A claim challenge that is still awaiting the browser leg."),
|
|
1944
|
+
zod
|
|
1945
|
+
.object({
|
|
1946
|
+
status: zod.enum(["completed"]).describe("The claim has completed."),
|
|
1947
|
+
team_id: zod.string().regex(getClaimStatusResponseTwoTeamIdRegExp),
|
|
1948
|
+
claimed_at: zod.iso
|
|
1949
|
+
.datetime({ offset: true })
|
|
1950
|
+
.describe("The time when the project was claimed."),
|
|
1951
|
+
dashboard_url: zod.url().describe("The dashboard URL for the owning team."),
|
|
1952
|
+
})
|
|
1953
|
+
.describe(
|
|
1954
|
+
"A completed claim. Carries the owning team, when the claim landed, and the\ndashboard where it can be managed, so a generated client can rely on those\nfields being present whenever `status` is `completed`.\n",
|
|
1955
|
+
),
|
|
1956
|
+
])
|
|
1957
|
+
.describe(
|
|
1958
|
+
"The state of a claim challenge. While pending it carries only `status`; once\ncompleted it also carries the owning team, the claim timestamp, and the\ndashboard URL. Modelled as discriminated variants so a `pending` response can\nnever carry stale completion fields and a `completed` response always carries\nthem.\n",
|
|
1959
|
+
);
|
|
1960
|
+
|
|
1961
|
+
/**
|
|
1962
|
+
* Called by the browser after the developer authenticates on the claim page.
|
|
1963
|
+
Authenticated by the `__nextgen_session` cookie, it attaches the project to
|
|
1964
|
+
the developer's personal team using the `challenge_id` from the claim URL as
|
|
1965
|
+
its single-use, browser-safe authorization.
|
|
1966
|
+
|
|
1967
|
+
* @summary Complete a project claim
|
|
1968
|
+
*/
|
|
1969
|
+
export const completeClaimPathProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1970
|
+
|
|
1971
|
+
export const CompleteClaimParams = zod.object({
|
|
1972
|
+
project_id: zod.string().regex(completeClaimPathProjectIdRegExp),
|
|
1973
|
+
});
|
|
1974
|
+
|
|
1975
|
+
export const completeClaimBodyChallengeIdRegExp = new RegExp("^ch_[a-zA-Z0-9_-]+$");
|
|
1976
|
+
|
|
1977
|
+
export const CompleteClaimBody = zod
|
|
1978
|
+
.object({
|
|
1979
|
+
challenge_id: zod
|
|
1980
|
+
.string()
|
|
1981
|
+
.regex(completeClaimBodyChallengeIdRegExp)
|
|
1982
|
+
.describe("Unique identifier for this challenge (dialect-minted prefixed opaque string)."),
|
|
1983
|
+
})
|
|
1984
|
+
.describe("The request to complete a project claim.");
|
|
1985
|
+
|
|
1986
|
+
export const completeClaimResponseProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1987
|
+
export const completeClaimResponseTeamIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
1988
|
+
|
|
1989
|
+
export const CompleteClaimResponse = zod
|
|
1990
|
+
.object({
|
|
1991
|
+
project_id: zod.string().regex(completeClaimResponseProjectIdRegExp),
|
|
1992
|
+
team_id: zod.string().regex(completeClaimResponseTeamIdRegExp),
|
|
1993
|
+
claimed_at: zod.iso
|
|
1994
|
+
.datetime({ offset: true })
|
|
1995
|
+
.describe("The time when the project was claimed."),
|
|
1996
|
+
})
|
|
1997
|
+
.describe("The result of a completed project claim.");
|
|
2143
1998
|
|
|
2144
1999
|
/**
|
|
2145
2000
|
* Creates an anonymous session shell with no user and no factors (`state: building`).
|
|
@@ -2150,8 +2005,16 @@ Use this explicitly when you want to:
|
|
|
2150
2005
|
can be correlated with the eventual authenticated session from the start.
|
|
2151
2006
|
- Track anonymous state (bot detection, device fingerprint) that survives until authentication.
|
|
2152
2007
|
|
|
2153
|
-
|
|
2154
|
-
|
|
2008
|
+
Creating a session is an app-plane operation on the project credential
|
|
2009
|
+
(`session.write`). The returned `session_token` is a session credential for the
|
|
2010
|
+
end-user client, not a management scope: it is delivered as the
|
|
2011
|
+
`__nextgen_session` cookie and authorises the self-service operations
|
|
2012
|
+
`GET /sessions/me` and `DELETE /sessions/me` (`nextgenSession` scheme). The
|
|
2013
|
+
by-id operations `GET /sessions/{session_id}` and `DELETE /sessions/{session_id}`
|
|
2014
|
+
are operator endpoints and require `session.read` / `session.delete` instead.
|
|
2015
|
+
|
|
2016
|
+
The `session_token` is superseded when a handoff exchange completes — clients must
|
|
2017
|
+
replace it at that point.
|
|
2155
2018
|
|
|
2156
2019
|
Anonymous sessions expire aggressively (10-minute TTL). The TTL resets to the configured
|
|
2157
2020
|
full session TTL when the first authentication factor is written via a completing `auth_attempt`.
|
|
@@ -2176,70 +2039,107 @@ export const CreateSessionBody = zod
|
|
|
2176
2039
|
.describe("Request to create an anonymous session shell.");
|
|
2177
2040
|
|
|
2178
2041
|
/**
|
|
2179
|
-
* Returns
|
|
2180
|
-
|
|
2042
|
+
* Returns the sessions of a project, paginated with a cursor.
|
|
2043
|
+
Sessions of every lifecycle state are returned; each carries its `state`.
|
|
2044
|
+
Requires `session.read` permission.
|
|
2181
2045
|
|
|
2182
|
-
* @summary
|
|
2046
|
+
* @summary Query sessions
|
|
2183
2047
|
*/
|
|
2184
|
-
export const
|
|
2185
|
-
export const listSessionsQueryLimitMax = 100;
|
|
2186
|
-
|
|
2187
|
-
export const listSessionsQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2188
|
-
export const listSessionsQueryUserIdRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
2048
|
+
export const querySessionsQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2189
2049
|
|
|
2190
|
-
export const
|
|
2191
|
-
limit: zod
|
|
2192
|
-
.number()
|
|
2193
|
-
.min(1)
|
|
2194
|
-
.max(listSessionsQueryLimitMax)
|
|
2195
|
-
.default(listSessionsQueryLimitDefault)
|
|
2196
|
-
.describe("Maximum number of items to return."),
|
|
2197
|
-
page_token: zod
|
|
2198
|
-
.string()
|
|
2199
|
-
.optional()
|
|
2200
|
-
.describe(
|
|
2201
|
-
"Token for fetching the next page of results.\nObtain this value from `next_page_token` in the previous response.\nOmit to start from the beginning.\nIts format is opaque and may change between releases.\n",
|
|
2202
|
-
),
|
|
2050
|
+
export const QuerySessionsQueryParams = zod.strictObject({
|
|
2203
2051
|
project_id: zod
|
|
2204
2052
|
.string()
|
|
2205
|
-
.regex(
|
|
2053
|
+
.regex(querySessionsQueryProjectIdRegExp)
|
|
2206
2054
|
.describe("The unique identifier of the project"),
|
|
2207
|
-
state: zod
|
|
2208
|
-
.enum(["building", "active", "expired", "revoked"])
|
|
2209
|
-
.optional()
|
|
2210
|
-
.describe("Filter sessions by lifecycle state."),
|
|
2211
|
-
user_id: zod
|
|
2212
|
-
.string()
|
|
2213
|
-
.regex(listSessionsQueryUserIdRegExp)
|
|
2214
|
-
.optional()
|
|
2215
|
-
.describe("Filter sessions by user."),
|
|
2216
2055
|
});
|
|
2217
2056
|
|
|
2218
|
-
export const
|
|
2219
|
-
export const
|
|
2220
|
-
|
|
2221
|
-
export const
|
|
2057
|
+
export const querySessionsBodyLimitDefault = 20;
|
|
2058
|
+
export const querySessionsBodyLimitMax = 100;
|
|
2059
|
+
|
|
2060
|
+
export const QuerySessionsBody = zod
|
|
2061
|
+
.object({
|
|
2062
|
+
limit: zod
|
|
2063
|
+
.number()
|
|
2064
|
+
.min(1)
|
|
2065
|
+
.max(querySessionsBodyLimitMax)
|
|
2066
|
+
.default(querySessionsBodyLimitDefault),
|
|
2067
|
+
page_token: zod
|
|
2068
|
+
.union([zod.string(), zod.null()])
|
|
2069
|
+
.optional()
|
|
2070
|
+
.describe("Token to retrieve the next page of results."),
|
|
2071
|
+
sorting: zod
|
|
2072
|
+
.object({
|
|
2073
|
+
field: zod
|
|
2074
|
+
.enum(["created_at", "user_id"])
|
|
2075
|
+
.describe(
|
|
2076
|
+
"Field to sort sessions by. Only stored columns are sortable: the keyset\ncursor holds the last row's sort values, so a computed value such as\n`state` would skip or duplicate rows between pages.\n",
|
|
2077
|
+
),
|
|
2078
|
+
direction: zod.enum(["asc", "desc"]),
|
|
2079
|
+
})
|
|
2080
|
+
.optional(),
|
|
2081
|
+
filter: zod
|
|
2082
|
+
.array(
|
|
2083
|
+
zod.object({
|
|
2084
|
+
field: zod
|
|
2085
|
+
.enum(["created_at", "user_id", "state"])
|
|
2086
|
+
.describe(
|
|
2087
|
+
"Field to filter sessions by:\n- `created_at`: RFC3339 timestamp\n- `user_id`: user id\n- `state`: one of `building`, `active`, `expired`\n",
|
|
2088
|
+
),
|
|
2089
|
+
value: zod
|
|
2090
|
+
.union([zod.string(), zod.number(), zod.boolean(), zod.null()])
|
|
2091
|
+
.optional()
|
|
2092
|
+
.describe(
|
|
2093
|
+
"Filter-value specifies which values can be filtered by a query endpoint. This\nis a union of types. When a value is specified which is not assignable to the\nfield which is being filtered, a 400 error will be returned.\n",
|
|
2094
|
+
),
|
|
2095
|
+
operation: zod
|
|
2096
|
+
.enum([
|
|
2097
|
+
"equals",
|
|
2098
|
+
"not_equals",
|
|
2099
|
+
"contains",
|
|
2100
|
+
"not_contains",
|
|
2101
|
+
"less_than",
|
|
2102
|
+
"less_than_or_equal",
|
|
2103
|
+
"greater_than",
|
|
2104
|
+
"greater_than_or_equal",
|
|
2105
|
+
])
|
|
2106
|
+
.describe(
|
|
2107
|
+
"Filter operation defines the operations which can be used when filtering on a\nquery endpoint.\n",
|
|
2108
|
+
),
|
|
2109
|
+
}),
|
|
2110
|
+
)
|
|
2111
|
+
.optional()
|
|
2112
|
+
.describe("Filter criteria for querying sessions."),
|
|
2113
|
+
})
|
|
2114
|
+
.describe("Request to query the sessions of a project.");
|
|
2115
|
+
|
|
2116
|
+
export const querySessionsResponseSessionsItemSessionIdRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
2117
|
+
export const querySessionsResponseSessionsItemProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2118
|
+
export const querySessionsResponseSessionsItemUserIdOneRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
2119
|
+
export const querySessionsResponseSessionsItemFactorsItemPayloadOneUserIdRegExp = new RegExp(
|
|
2222
2120
|
"^user_[a-zA-Z0-9_-]+$",
|
|
2223
2121
|
);
|
|
2224
2122
|
|
|
2225
|
-
export const
|
|
2123
|
+
export const QuerySessionsResponse = zod
|
|
2226
2124
|
.object({
|
|
2227
2125
|
sessions: zod.array(
|
|
2228
2126
|
zod
|
|
2229
2127
|
.object({
|
|
2230
2128
|
session_id: zod
|
|
2231
2129
|
.string()
|
|
2232
|
-
.regex(
|
|
2233
|
-
.describe(
|
|
2234
|
-
|
|
2130
|
+
.regex(querySessionsResponseSessionsItemSessionIdRegExp)
|
|
2131
|
+
.describe(
|
|
2132
|
+
"Unique identifier for this session (dialect-minted prefixed opaque string).",
|
|
2133
|
+
),
|
|
2134
|
+
project_id: zod.string().regex(querySessionsResponseSessionsItemProjectIdRegExp),
|
|
2235
2135
|
state: zod
|
|
2236
|
-
.enum(["building", "active", "expired"
|
|
2136
|
+
.enum(["building", "active", "expired"])
|
|
2237
2137
|
.describe(
|
|
2238
|
-
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n
|
|
2138
|
+
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n",
|
|
2239
2139
|
),
|
|
2240
2140
|
user_id: zod
|
|
2241
2141
|
.union([
|
|
2242
|
-
zod.string().regex(
|
|
2142
|
+
zod.string().regex(querySessionsResponseSessionsItemUserIdOneRegExp),
|
|
2243
2143
|
zod.null(),
|
|
2244
2144
|
])
|
|
2245
2145
|
.optional()
|
|
@@ -2275,7 +2175,7 @@ export const ListSessionsResponse = zod
|
|
|
2275
2175
|
user_id: zod
|
|
2276
2176
|
.string()
|
|
2277
2177
|
.regex(
|
|
2278
|
-
|
|
2178
|
+
querySessionsResponseSessionsItemFactorsItemPayloadOneUserIdRegExp,
|
|
2279
2179
|
),
|
|
2280
2180
|
})
|
|
2281
2181
|
.describe("Identifier-specific factor metadata"),
|
|
@@ -2420,7 +2320,7 @@ export const ExchangeHandoffBody = zod
|
|
|
2420
2320
|
})
|
|
2421
2321
|
.describe("Request to exchange a handoff token for a session and session_token.");
|
|
2422
2322
|
|
|
2423
|
-
export const exchangeHandoffResponseSessionSessionIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2323
|
+
export const exchangeHandoffResponseSessionSessionIdRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
2424
2324
|
export const exchangeHandoffResponseSessionProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2425
2325
|
export const exchangeHandoffResponseSessionUserIdOneRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
2426
2326
|
export const exchangeHandoffResponseSessionFactorsItemPayloadOneUserIdRegExp = new RegExp(
|
|
@@ -2434,12 +2334,12 @@ export const ExchangeHandoffResponse = zod
|
|
|
2434
2334
|
session_id: zod
|
|
2435
2335
|
.string()
|
|
2436
2336
|
.regex(exchangeHandoffResponseSessionSessionIdRegExp)
|
|
2437
|
-
.describe("Unique identifier for this session."),
|
|
2337
|
+
.describe("Unique identifier for this session (dialect-minted prefixed opaque string)."),
|
|
2438
2338
|
project_id: zod.string().regex(exchangeHandoffResponseSessionProjectIdRegExp),
|
|
2439
2339
|
state: zod
|
|
2440
|
-
.enum(["building", "active", "expired"
|
|
2340
|
+
.enum(["building", "active", "expired"])
|
|
2441
2341
|
.describe(
|
|
2442
|
-
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n
|
|
2342
|
+
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n",
|
|
2443
2343
|
),
|
|
2444
2344
|
user_id: zod
|
|
2445
2345
|
.union([zod.string().regex(exchangeHandoffResponseSessionUserIdOneRegExp), zod.null()])
|
|
@@ -2568,7 +2468,7 @@ against the same `session_id`) to restore a dropped assurance level.
|
|
|
2568
2468
|
|
|
2569
2469
|
* @summary Get session state
|
|
2570
2470
|
*/
|
|
2571
|
-
export const getSessionPathSessionIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2471
|
+
export const getSessionPathSessionIdRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
2572
2472
|
|
|
2573
2473
|
export const GetSessionParams = zod.object({
|
|
2574
2474
|
session_id: zod
|
|
@@ -2586,7 +2486,7 @@ export const GetSessionQueryParams = zod.strictObject({
|
|
|
2586
2486
|
.describe("The unique identifier of the project"),
|
|
2587
2487
|
});
|
|
2588
2488
|
|
|
2589
|
-
export const getSessionResponseSessionIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2489
|
+
export const getSessionResponseSessionIdRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
2590
2490
|
export const getSessionResponseProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2591
2491
|
export const getSessionResponseUserIdOneRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
2592
2492
|
export const getSessionResponseFactorsItemPayloadOneUserIdRegExp = new RegExp(
|
|
@@ -2598,12 +2498,12 @@ export const GetSessionResponse = zod
|
|
|
2598
2498
|
session_id: zod
|
|
2599
2499
|
.string()
|
|
2600
2500
|
.regex(getSessionResponseSessionIdRegExp)
|
|
2601
|
-
.describe("Unique identifier for this session."),
|
|
2501
|
+
.describe("Unique identifier for this session (dialect-minted prefixed opaque string)."),
|
|
2602
2502
|
project_id: zod.string().regex(getSessionResponseProjectIdRegExp),
|
|
2603
2503
|
state: zod
|
|
2604
|
-
.enum(["building", "active", "expired"
|
|
2504
|
+
.enum(["building", "active", "expired"])
|
|
2605
2505
|
.describe(
|
|
2606
|
-
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n
|
|
2506
|
+
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n",
|
|
2607
2507
|
),
|
|
2608
2508
|
user_id: zod
|
|
2609
2509
|
.union([zod.string().regex(getSessionResponseUserIdOneRegExp), zod.null()])
|
|
@@ -2714,14 +2614,19 @@ export const GetSessionResponse = zod
|
|
|
2714
2614
|
);
|
|
2715
2615
|
|
|
2716
2616
|
/**
|
|
2717
|
-
*
|
|
2617
|
+
* Permanently deletes the session, terminating it immediately.
|
|
2618
|
+
|
|
2619
|
+
This is the operator revoke path and requires the `session.delete` scope on a
|
|
2620
|
+
project-bound credential. End-user logout with the `__nextgen_session` cookie is
|
|
2621
|
+
`DELETE /sessions/me` (`nextgenSession` scheme).
|
|
2718
2622
|
|
|
2719
|
-
|
|
2720
|
-
After
|
|
2623
|
+
Idempotent: deleting a session that does not exist (or was already deleted)
|
|
2624
|
+
still returns 204. After deletion, any tokens derived from the session are
|
|
2625
|
+
invalidated.
|
|
2721
2626
|
|
|
2722
2627
|
* @summary Revoke session
|
|
2723
2628
|
*/
|
|
2724
|
-
export const revokeSessionPathSessionIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2629
|
+
export const revokeSessionPathSessionIdRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
2725
2630
|
|
|
2726
2631
|
export const RevokeSessionParams = zod.object({
|
|
2727
2632
|
session_id: zod
|
|
@@ -2749,7 +2654,7 @@ against the same `session_id`) to restore a dropped assurance level.
|
|
|
2749
2654
|
|
|
2750
2655
|
* @summary Get my session state
|
|
2751
2656
|
*/
|
|
2752
|
-
export const getMySessionResponseSessionIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2657
|
+
export const getMySessionResponseSessionIdRegExp = new RegExp("^sess_[a-zA-Z0-9_-]+$");
|
|
2753
2658
|
export const getMySessionResponseProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
2754
2659
|
export const getMySessionResponseUserIdOneRegExp = new RegExp("^user_[a-zA-Z0-9_-]+$");
|
|
2755
2660
|
export const getMySessionResponseFactorsItemPayloadOneUserIdRegExp = new RegExp(
|
|
@@ -2761,12 +2666,12 @@ export const GetMySessionResponse = zod
|
|
|
2761
2666
|
session_id: zod
|
|
2762
2667
|
.string()
|
|
2763
2668
|
.regex(getMySessionResponseSessionIdRegExp)
|
|
2764
|
-
.describe("Unique identifier for this session."),
|
|
2669
|
+
.describe("Unique identifier for this session (dialect-minted prefixed opaque string)."),
|
|
2765
2670
|
project_id: zod.string().regex(getMySessionResponseProjectIdRegExp),
|
|
2766
2671
|
state: zod
|
|
2767
|
-
.enum(["building", "active", "expired"
|
|
2672
|
+
.enum(["building", "active", "expired"])
|
|
2768
2673
|
.describe(
|
|
2769
|
-
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n
|
|
2674
|
+
"Current lifecycle state of the session:\n- `building`: has a user factor but is still gathering authentication factors\n- `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age\n- `expired`: TTL elapsed\n",
|
|
2770
2675
|
),
|
|
2771
2676
|
user_id: zod
|
|
2772
2677
|
.union([zod.string().regex(getMySessionResponseUserIdOneRegExp), zod.null()])
|
|
@@ -2877,10 +2782,12 @@ export const GetMySessionResponse = zod
|
|
|
2877
2782
|
);
|
|
2878
2783
|
|
|
2879
2784
|
/**
|
|
2880
|
-
* Create a new schema. The
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2785
|
+
* Create a new schema. The optional `$id` field is the JSON Schema document
|
|
2786
|
+
URI used to identify the schema in future requests (GitOps-stable identity,
|
|
2787
|
+
not a free-form resource primary key). When `$id` is omitted, the server
|
|
2788
|
+
generates a `sch_*` URL. When provided, `$id` must be unique within the
|
|
2789
|
+
project and should ideally be a valid URI pointing at where the schema can
|
|
2790
|
+
be accessed.
|
|
2884
2791
|
|
|
2885
2792
|
The schema can either be a concrete schema, e.g. a user schema, or a
|
|
2886
2793
|
schema-url which will be resolved by the server.
|
|
@@ -3027,16 +2934,16 @@ export const CreateSchemaBody = zod.union([
|
|
|
3027
2934
|
"x-mfa": zod
|
|
3028
2935
|
.boolean()
|
|
3029
2936
|
.default(createSchemaBodyOnePropertiesXMfaDefault)
|
|
3030
|
-
.describe("Whether this property is used for multi-factor authentication or not"),
|
|
2937
|
+
.describe("Whether this property is used for multi-factor authentication or not\n"),
|
|
3031
2938
|
properties: zod
|
|
3032
2939
|
.record(zod.string(), zod.unknown())
|
|
3033
2940
|
.optional()
|
|
3034
2941
|
.describe(
|
|
3035
|
-
"A map of additional properties for the user definition, where the key is
|
|
2942
|
+
"A map of additional properties for the user definition, where the key is\nthe property name and the value is the property schema.\n",
|
|
3036
2943
|
),
|
|
3037
2944
|
})
|
|
3038
2945
|
.describe(
|
|
3039
|
-
'This schema is missing `\"allOf\": [{\"$ref\": \"https:\/\/json-schema.org\/draft\/2020-12\/schema\"}],`. \nThis is done because a lot of code generators cannot handle that.\n',
|
|
2946
|
+
'This schema is missing `\"allOf\": [{\"$ref\": \"https:\/\/json-schema.org\/draft\/2020-12\/schema\"}],`. \nThis is done because a lot of code generators cannot handle that.\n\nA few properties are reserved:\n- id: is used to return the id of the user \n- metadata: is used to embed metadata of the user, like creation date, \n status,... in a return object\n',
|
|
3040
2947
|
),
|
|
3041
2948
|
)
|
|
3042
2949
|
.optional()
|
|
@@ -3096,7 +3003,7 @@ export const ListSchemasQueryParams = zod.strictObject({
|
|
|
3096
3003
|
|
|
3097
3004
|
export const ListSchemasResponseItem = zod.object({
|
|
3098
3005
|
id: zod.string().describe("The unique identifier for this schema."),
|
|
3099
|
-
|
|
3006
|
+
created_at: zod.iso.datetime({ offset: true }),
|
|
3100
3007
|
});
|
|
3101
3008
|
export const ListSchemasResponse = zod.array(ListSchemasResponseItem);
|
|
3102
3009
|
|
|
@@ -3237,16 +3144,16 @@ export const GetSchemaByIdResponse = zod
|
|
|
3237
3144
|
"x-mfa": zod
|
|
3238
3145
|
.boolean()
|
|
3239
3146
|
.default(getSchemaByIdResponseOnePropertiesXMfaDefault)
|
|
3240
|
-
.describe("Whether this property is used for multi-factor authentication or not"),
|
|
3147
|
+
.describe("Whether this property is used for multi-factor authentication or not\n"),
|
|
3241
3148
|
properties: zod
|
|
3242
3149
|
.record(zod.string(), zod.unknown())
|
|
3243
3150
|
.optional()
|
|
3244
3151
|
.describe(
|
|
3245
|
-
"A map of additional properties for the user definition, where the key is
|
|
3152
|
+
"A map of additional properties for the user definition, where the key is\nthe property name and the value is the property schema.\n",
|
|
3246
3153
|
),
|
|
3247
3154
|
})
|
|
3248
3155
|
.describe(
|
|
3249
|
-
'This schema is missing `\"allOf\": [{\"$ref\": \"https:\/\/json-schema.org\/draft\/2020-12\/schema\"}],`. \nThis is done because a lot of code generators cannot handle that.\n',
|
|
3156
|
+
'This schema is missing `\"allOf\": [{\"$ref\": \"https:\/\/json-schema.org\/draft\/2020-12\/schema\"}],`. \nThis is done because a lot of code generators cannot handle that.\n\nA few properties are reserved:\n- id: is used to return the id of the user \n- metadata: is used to embed metadata of the user, like creation date, \n status,... in a return object\n',
|
|
3250
3157
|
),
|
|
3251
3158
|
)
|
|
3252
3159
|
.optional()
|
|
@@ -4200,60 +4107,123 @@ export const DeleteFlowDefinitionQueryParams = zod.strictObject({
|
|
|
4200
4107
|
});
|
|
4201
4108
|
|
|
4202
4109
|
/**
|
|
4203
|
-
*
|
|
4204
|
-
Alternatively, the status of a flow definition can also be set via the `POST /flow_definitions` and `PUT /flow_definitions/{id}` endpoints by setting the `status` attribute in the flow definition payload.
|
|
4205
|
-
|
|
4206
|
-
* @summary Activate a flow definition by ID.
|
|
4110
|
+
* @summary Create team
|
|
4207
4111
|
*/
|
|
4208
|
-
export const
|
|
4209
|
-
id: zod.string().describe("The id returned by the POST \/flow_definitions endpoint.\n"),
|
|
4210
|
-
});
|
|
4211
|
-
|
|
4212
|
-
export const activateFlowDefinitionQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4112
|
+
export const createTeamQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4213
4113
|
|
|
4214
|
-
export const
|
|
4114
|
+
export const CreateTeamQueryParams = zod.strictObject({
|
|
4215
4115
|
project_id: zod
|
|
4216
4116
|
.string()
|
|
4217
|
-
.regex(
|
|
4117
|
+
.regex(createTeamQueryProjectIdRegExp)
|
|
4218
4118
|
.describe("The unique identifier of the project"),
|
|
4219
4119
|
});
|
|
4220
4120
|
|
|
4221
|
-
|
|
4222
|
-
* Deactivates a flow definition in the `active` state by transitioning it to the `draft` state.
|
|
4223
|
-
Flow definitions in `draft` state cannot be used to start new flows. Existing flows that use the deactivated flow definition must gracefully handle this.
|
|
4224
|
-
Alternatively, the status of a flow definition can also be set via the `POST /flow_definitions` and `PUT /flow_definitions/{id}` endpoints by setting the `status` attribute in the flow definition payload.
|
|
4225
|
-
|
|
4226
|
-
* @summary Deactivate a flow definition by ID.
|
|
4227
|
-
*/
|
|
4228
|
-
export const DeactivateFlowDefinitionParams = zod.object({
|
|
4229
|
-
id: zod.string().describe("The id returned by the POST \/flow_definitions endpoint.\n"),
|
|
4230
|
-
});
|
|
4231
|
-
|
|
4232
|
-
export const deactivateFlowDefinitionQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4121
|
+
export const createTeamBodyNameMax = 200;
|
|
4233
4122
|
|
|
4234
|
-
export const
|
|
4235
|
-
|
|
4123
|
+
export const CreateTeamBody = zod.object({
|
|
4124
|
+
name: zod
|
|
4236
4125
|
.string()
|
|
4237
|
-
.
|
|
4238
|
-
.
|
|
4126
|
+
.min(1)
|
|
4127
|
+
.max(createTeamBodyNameMax)
|
|
4128
|
+
.describe("The name of the team. Must be unique within the project."),
|
|
4239
4129
|
});
|
|
4240
4130
|
|
|
4241
4131
|
/**
|
|
4242
|
-
*
|
|
4132
|
+
* Returns the teams of a project, paginated with a cursor.
|
|
4133
|
+
Teams of every lifecycle status are returned; each carries its `status`.
|
|
4134
|
+
|
|
4135
|
+
* @summary Query teams
|
|
4243
4136
|
*/
|
|
4244
|
-
export const
|
|
4137
|
+
export const queryTeamsQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4245
4138
|
|
|
4246
|
-
export const
|
|
4139
|
+
export const QueryTeamsQueryParams = zod.strictObject({
|
|
4247
4140
|
project_id: zod
|
|
4248
4141
|
.string()
|
|
4249
|
-
.regex(
|
|
4142
|
+
.regex(queryTeamsQueryProjectIdRegExp)
|
|
4250
4143
|
.describe("The unique identifier of the project"),
|
|
4251
4144
|
});
|
|
4252
4145
|
|
|
4253
|
-
export const
|
|
4146
|
+
export const queryTeamsBodyLimitDefault = 20;
|
|
4147
|
+
export const queryTeamsBodyLimitMax = 100;
|
|
4148
|
+
|
|
4149
|
+
export const QueryTeamsBody = zod
|
|
4150
|
+
.object({
|
|
4151
|
+
limit: zod.number().min(1).max(queryTeamsBodyLimitMax).default(queryTeamsBodyLimitDefault),
|
|
4152
|
+
page_token: zod
|
|
4153
|
+
.union([zod.string(), zod.null()])
|
|
4154
|
+
.optional()
|
|
4155
|
+
.describe(
|
|
4156
|
+
"Token to retrieve the next page of results. Must be sent with the same\n`sorting` as the request that issued the token. Omitting `sorting` reuses\nthe default sort and only succeeds when that default matches the token.\n",
|
|
4157
|
+
),
|
|
4158
|
+
sorting: zod
|
|
4159
|
+
.object({
|
|
4160
|
+
field: zod.enum(["created_at"]),
|
|
4161
|
+
direction: zod.enum(["asc", "desc"]),
|
|
4162
|
+
})
|
|
4163
|
+
.optional(),
|
|
4164
|
+
filter: zod
|
|
4165
|
+
.array(
|
|
4166
|
+
zod.object({
|
|
4167
|
+
field: zod.enum(["created_at"]),
|
|
4168
|
+
value: zod
|
|
4169
|
+
.union([zod.string(), zod.number(), zod.boolean(), zod.null()])
|
|
4170
|
+
.optional()
|
|
4171
|
+
.describe(
|
|
4172
|
+
"Filter-value specifies which values can be filtered by a query endpoint. This\nis a union of types. When a value is specified which is not assignable to the\nfield which is being filtered, a 400 error will be returned.\n",
|
|
4173
|
+
),
|
|
4174
|
+
operation: zod
|
|
4175
|
+
.enum([
|
|
4176
|
+
"equals",
|
|
4177
|
+
"not_equals",
|
|
4178
|
+
"contains",
|
|
4179
|
+
"not_contains",
|
|
4180
|
+
"less_than",
|
|
4181
|
+
"less_than_or_equal",
|
|
4182
|
+
"greater_than",
|
|
4183
|
+
"greater_than_or_equal",
|
|
4184
|
+
])
|
|
4185
|
+
.describe(
|
|
4186
|
+
"Filter operation defines the operations which can be used when filtering on a\nquery endpoint.\n",
|
|
4187
|
+
),
|
|
4188
|
+
}),
|
|
4189
|
+
)
|
|
4190
|
+
.optional()
|
|
4191
|
+
.describe("Filter criteria for querying teams."),
|
|
4192
|
+
})
|
|
4193
|
+
.describe("Request to query the teams of a project.");
|
|
4194
|
+
|
|
4195
|
+
export const QueryTeamsResponse = zod
|
|
4196
|
+
.object({
|
|
4197
|
+
teams: zod.array(
|
|
4198
|
+
zod
|
|
4199
|
+
.object({
|
|
4200
|
+
id: zod.string().describe("The unique identifier of the team."),
|
|
4201
|
+
name: zod.string().describe("The name of the team."),
|
|
4202
|
+
status: zod
|
|
4203
|
+
.enum(["active", "deactivated"])
|
|
4204
|
+
.describe(
|
|
4205
|
+
"The lifecycle state of a team.\n\nactive: The team is available for use.\ndeactivated: The team is no longer active but is retained for historical and audit purposes.\n",
|
|
4206
|
+
),
|
|
4207
|
+
created_at: zod.iso
|
|
4208
|
+
.datetime({ offset: true })
|
|
4209
|
+
.describe("The time when the team was created."),
|
|
4210
|
+
updated_at: zod.iso
|
|
4211
|
+
.datetime({ offset: true })
|
|
4212
|
+
.describe("The time when the team was last updated."),
|
|
4213
|
+
})
|
|
4214
|
+
.describe("Details of a team."),
|
|
4215
|
+
),
|
|
4216
|
+
next_page_token: zod
|
|
4217
|
+
.union([zod.string(), zod.null()])
|
|
4218
|
+
.optional()
|
|
4219
|
+
.describe(
|
|
4220
|
+
"Token to pass as `page_token` in the next request to fetch the following page.\nAbsent when there are no more results. The follow-up request must repeat the\nsame `sorting` that produced this token (omit only when both pages use the default).\n",
|
|
4221
|
+
),
|
|
4222
|
+
})
|
|
4223
|
+
.describe("Paginated list of teams.");
|
|
4254
4224
|
|
|
4255
4225
|
/**
|
|
4256
|
-
* Returns
|
|
4226
|
+
* Returns a Team by its id.
|
|
4257
4227
|
|
|
4258
4228
|
* @summary Get team
|
|
4259
4229
|
*/
|
|
@@ -4275,9 +4245,225 @@ export const GetTeamQueryParams = zod.strictObject({
|
|
|
4275
4245
|
export const GetTeamResponse = zod
|
|
4276
4246
|
.object({
|
|
4277
4247
|
id: zod.string().describe("The unique identifier of the team."),
|
|
4278
|
-
|
|
4279
|
-
|
|
4248
|
+
name: zod.string().describe("The name of the team."),
|
|
4249
|
+
status: zod
|
|
4250
|
+
.enum(["active", "deactivated"])
|
|
4251
|
+
.describe(
|
|
4252
|
+
"The lifecycle state of a team.\n\nactive: The team is available for use.\ndeactivated: The team is no longer active but is retained for historical and audit purposes.\n",
|
|
4253
|
+
),
|
|
4254
|
+
created_at: zod.iso.datetime({ offset: true }).describe("The time when the team was created."),
|
|
4255
|
+
updated_at: zod.iso
|
|
4256
|
+
.datetime({ offset: true })
|
|
4257
|
+
.describe("The time when the team was last updated."),
|
|
4258
|
+
})
|
|
4259
|
+
.describe("Details of a team.");
|
|
4260
|
+
|
|
4261
|
+
/**
|
|
4262
|
+
* Deactivates the team.
|
|
4263
|
+
|
|
4264
|
+
The team is tombstoned rather than erased: it stays readable through
|
|
4265
|
+
getTeam with status `deactivated`. Its memberships are removed and the
|
|
4266
|
+
users whose lifecycle it owns are deactivated with it.
|
|
4267
|
+
|
|
4268
|
+
The request is idempotent. Deleting a team that is already deactivated
|
|
4269
|
+
or doesn't exist succeeds without changing anything.
|
|
4270
|
+
|
|
4271
|
+
* @summary Delete team
|
|
4272
|
+
*/
|
|
4273
|
+
export const deleteTeamPathTeamIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4274
|
+
|
|
4275
|
+
export const DeleteTeamParams = zod.object({
|
|
4276
|
+
team_id: zod.string().regex(deleteTeamPathTeamIdRegExp),
|
|
4277
|
+
});
|
|
4278
|
+
|
|
4279
|
+
export const deleteTeamQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4280
|
+
|
|
4281
|
+
export const DeleteTeamQueryParams = zod.strictObject({
|
|
4282
|
+
project_id: zod
|
|
4283
|
+
.string()
|
|
4284
|
+
.regex(deleteTeamQueryProjectIdRegExp)
|
|
4285
|
+
.describe("The unique identifier of the project"),
|
|
4286
|
+
});
|
|
4287
|
+
|
|
4288
|
+
/**
|
|
4289
|
+
* Update team. Only active teams can be updated.
|
|
4290
|
+
|
|
4291
|
+
* @summary Update team
|
|
4292
|
+
*/
|
|
4293
|
+
export const updateTeamPathTeamIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4294
|
+
|
|
4295
|
+
export const UpdateTeamParams = zod.object({
|
|
4296
|
+
team_id: zod.string().regex(updateTeamPathTeamIdRegExp),
|
|
4297
|
+
});
|
|
4298
|
+
|
|
4299
|
+
export const updateTeamQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4300
|
+
|
|
4301
|
+
export const UpdateTeamQueryParams = zod.strictObject({
|
|
4302
|
+
project_id: zod
|
|
4303
|
+
.string()
|
|
4304
|
+
.regex(updateTeamQueryProjectIdRegExp)
|
|
4305
|
+
.describe("The unique identifier of the project"),
|
|
4306
|
+
});
|
|
4307
|
+
|
|
4308
|
+
export const updateTeamBodyNameMax = 200;
|
|
4309
|
+
|
|
4310
|
+
export const UpdateTeamBody = zod.object({
|
|
4311
|
+
name: zod
|
|
4312
|
+
.string()
|
|
4313
|
+
.min(1)
|
|
4314
|
+
.max(updateTeamBodyNameMax)
|
|
4315
|
+
.optional()
|
|
4316
|
+
.describe("The name of the team. Must be unique within the project."),
|
|
4317
|
+
});
|
|
4318
|
+
|
|
4319
|
+
export const UpdateTeamResponse = zod
|
|
4320
|
+
.object({
|
|
4321
|
+
id: zod.string().describe("The unique identifier of the team."),
|
|
4322
|
+
name: zod.string().describe("The name of the team."),
|
|
4323
|
+
status: zod
|
|
4324
|
+
.enum(["active", "deactivated"])
|
|
4325
|
+
.describe(
|
|
4326
|
+
"The lifecycle state of a team.\n\nactive: The team is available for use.\ndeactivated: The team is no longer active but is retained for historical and audit purposes.\n",
|
|
4327
|
+
),
|
|
4328
|
+
created_at: zod.iso.datetime({ offset: true }).describe("The time when the team was created."),
|
|
4329
|
+
updated_at: zod.iso
|
|
4280
4330
|
.datetime({ offset: true })
|
|
4281
4331
|
.describe("The time when the team was last updated."),
|
|
4282
4332
|
})
|
|
4283
|
-
.describe("
|
|
4333
|
+
.describe("Details of a team.");
|
|
4334
|
+
|
|
4335
|
+
/**
|
|
4336
|
+
* Publishes a new immutable branding revision for the project. Branding
|
|
4337
|
+
revisions cannot be updated or deleted; every edit publishes a new
|
|
4338
|
+
revision, and flow responses resolve the latest revision per project
|
|
4339
|
+
(see ADR 040).
|
|
4340
|
+
|
|
4341
|
+
The `liquid_template` is validated lexically on save (size, encoding,
|
|
4342
|
+
banned patterns such as `<script>` tags, inline event handlers, and the
|
|
4343
|
+
`| raw` filter). Authoritative LiquidJS validation runs at authoring
|
|
4344
|
+
time via `zitadel plan` / `zitadel apply`.
|
|
4345
|
+
|
|
4346
|
+
* @summary Publish a new branding revision
|
|
4347
|
+
*/
|
|
4348
|
+
export const createBrandingQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4349
|
+
|
|
4350
|
+
export const CreateBrandingQueryParams = zod.strictObject({
|
|
4351
|
+
project_id: zod
|
|
4352
|
+
.string()
|
|
4353
|
+
.regex(createBrandingQueryProjectIdRegExp)
|
|
4354
|
+
.describe("The unique identifier of the project"),
|
|
4355
|
+
});
|
|
4356
|
+
|
|
4357
|
+
export const createBrandingBodyLayoutDefault = `centered`;
|
|
4358
|
+
export const createBrandingBodyLiquidTemplateMax = 131072;
|
|
4359
|
+
|
|
4360
|
+
export const CreateBrandingBody = zod
|
|
4361
|
+
.object({
|
|
4362
|
+
layout: zod
|
|
4363
|
+
.enum(["centered", "split"])
|
|
4364
|
+
.default(createBrandingBodyLayoutDefault)
|
|
4365
|
+
.describe(
|
|
4366
|
+
"Layout preset selector. The default.liquid master template uses this\nto branch into layout variants. Customers who eject the template\ncan ignore this field entirely; it also serves as the degrade target\nwhen a custom template fails component-side validation.\n",
|
|
4367
|
+
),
|
|
4368
|
+
liquid_template: zod
|
|
4369
|
+
.string()
|
|
4370
|
+
.max(createBrandingBodyLiquidTemplateMax)
|
|
4371
|
+
.optional()
|
|
4372
|
+
.describe(
|
|
4373
|
+
"The LiquidJS template string for rendering this step. The orchestrator\nparses this template, injects the capability dictionaries as context,\nand renders the output HTML into its Shadow DOM.\n",
|
|
4374
|
+
),
|
|
4375
|
+
logo_url: zod.url().optional().describe("Team logo URL."),
|
|
4376
|
+
font_url: zod
|
|
4377
|
+
.url()
|
|
4378
|
+
.optional()
|
|
4379
|
+
.describe(
|
|
4380
|
+
"Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in\nv1: `POST \/branding` rejects a non-empty value, because the login\ncomponent loads this stylesheet at document level (shadow-scoped\n`@font-face` rules never register faces) and an arbitrary URL would\ngrant `branding.write` page-wide CSS control over the embedding\napplication. Safe tenant font delivery is an ADR 040 follow-up;\nuntil then, load fonts from the embedding page.\n",
|
|
4381
|
+
),
|
|
4382
|
+
hero_url: zod.url().optional().describe("Hero\/background image URL (used by split layout)."),
|
|
4383
|
+
})
|
|
4384
|
+
.describe(
|
|
4385
|
+
"Branding configuration. Appears in two places with one shape:\n\n- On flow responses as a read-only projection: the server resolves the\n latest branding revision for the project per step response (falling\n back to built-in defaults when none is stored). Branding is configured\n via the Branding API \/ `zitadel apply`, not the Flow API.\n- As the request body of `POST \/branding`, which publishes the same\n shape as a new immutable revision (see ADR 040).\n",
|
|
4386
|
+
);
|
|
4387
|
+
|
|
4388
|
+
/**
|
|
4389
|
+
* Lists branding revisions for the project, newest first, capped at the
|
|
4390
|
+
100 most recent. The first entry is the revision flow responses
|
|
4391
|
+
currently resolve. Deliberately unpaginated in v1 — list endpoints
|
|
4392
|
+
gain a real query mechanism together (ADR 031); advertising pagination
|
|
4393
|
+
parameters the server ignores would be worse than none.
|
|
4394
|
+
|
|
4395
|
+
* @summary List branding revisions
|
|
4396
|
+
*/
|
|
4397
|
+
export const listBrandingQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4398
|
+
|
|
4399
|
+
export const ListBrandingQueryParams = zod.strictObject({
|
|
4400
|
+
project_id: zod
|
|
4401
|
+
.string()
|
|
4402
|
+
.regex(listBrandingQueryProjectIdRegExp)
|
|
4403
|
+
.describe("The unique identifier of the project"),
|
|
4404
|
+
});
|
|
4405
|
+
|
|
4406
|
+
export const ListBrandingResponseItem = zod.object({
|
|
4407
|
+
id: zod.string().describe("The unique identifier of this branding revision."),
|
|
4408
|
+
created_at: zod.iso.datetime({ offset: true }).describe("When this revision was published."),
|
|
4409
|
+
});
|
|
4410
|
+
export const ListBrandingResponse = zod.array(ListBrandingResponseItem);
|
|
4411
|
+
|
|
4412
|
+
/**
|
|
4413
|
+
* Retrieves a single branding revision, including its stored configuration.
|
|
4414
|
+
* @summary Get a branding revision by ID
|
|
4415
|
+
*/
|
|
4416
|
+
export const GetBrandingByIdParams = zod.object({
|
|
4417
|
+
id: zod.string(),
|
|
4418
|
+
});
|
|
4419
|
+
|
|
4420
|
+
export const getBrandingByIdQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
|
|
4421
|
+
|
|
4422
|
+
export const GetBrandingByIdQueryParams = zod.strictObject({
|
|
4423
|
+
project_id: zod
|
|
4424
|
+
.string()
|
|
4425
|
+
.regex(getBrandingByIdQueryProjectIdRegExp)
|
|
4426
|
+
.describe("The unique identifier of the project"),
|
|
4427
|
+
});
|
|
4428
|
+
|
|
4429
|
+
export const getBrandingByIdResponseBrandingLayoutDefault = `centered`;
|
|
4430
|
+
export const getBrandingByIdResponseBrandingLiquidTemplateMax = 131072;
|
|
4431
|
+
|
|
4432
|
+
export const GetBrandingByIdResponse = zod
|
|
4433
|
+
.object({
|
|
4434
|
+
id: zod.string().describe("The unique identifier of this branding revision."),
|
|
4435
|
+
created_at: zod.iso.datetime({ offset: true }).describe("When this revision was published."),
|
|
4436
|
+
branding: zod
|
|
4437
|
+
.object({
|
|
4438
|
+
layout: zod
|
|
4439
|
+
.enum(["centered", "split"])
|
|
4440
|
+
.default(getBrandingByIdResponseBrandingLayoutDefault)
|
|
4441
|
+
.describe(
|
|
4442
|
+
"Layout preset selector. The default.liquid master template uses this\nto branch into layout variants. Customers who eject the template\ncan ignore this field entirely; it also serves as the degrade target\nwhen a custom template fails component-side validation.\n",
|
|
4443
|
+
),
|
|
4444
|
+
liquid_template: zod
|
|
4445
|
+
.string()
|
|
4446
|
+
.max(getBrandingByIdResponseBrandingLiquidTemplateMax)
|
|
4447
|
+
.optional()
|
|
4448
|
+
.describe(
|
|
4449
|
+
"The LiquidJS template string for rendering this step. The orchestrator\nparses this template, injects the capability dictionaries as context,\nand renders the output HTML into its Shadow DOM.\n",
|
|
4450
|
+
),
|
|
4451
|
+
logo_url: zod.url().optional().describe("Team logo URL."),
|
|
4452
|
+
font_url: zod
|
|
4453
|
+
.url()
|
|
4454
|
+
.optional()
|
|
4455
|
+
.describe(
|
|
4456
|
+
"Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in\nv1: `POST \/branding` rejects a non-empty value, because the login\ncomponent loads this stylesheet at document level (shadow-scoped\n`@font-face` rules never register faces) and an arbitrary URL would\ngrant `branding.write` page-wide CSS control over the embedding\napplication. Safe tenant font delivery is an ADR 040 follow-up;\nuntil then, load fonts from the embedding page.\n",
|
|
4457
|
+
),
|
|
4458
|
+
hero_url: zod
|
|
4459
|
+
.url()
|
|
4460
|
+
.optional()
|
|
4461
|
+
.describe("Hero\/background image URL (used by split layout)."),
|
|
4462
|
+
})
|
|
4463
|
+
.describe(
|
|
4464
|
+
"Branding configuration. Appears in two places with one shape:\n\n- On flow responses as a read-only projection: the server resolves the\n latest branding revision for the project per step response (falling\n back to built-in defaults when none is stored). Branding is configured\n via the Branding API \/ `zitadel apply`, not the Flow API.\n- As the request body of `POST \/branding`, which publishes the same\n shape as a new immutable revision (see ADR 040).\n",
|
|
4465
|
+
),
|
|
4466
|
+
})
|
|
4467
|
+
.describe(
|
|
4468
|
+
"A stored branding revision. `branding` echoes the canonical stored\nconfiguration so clients (e.g. the CLI sync engine) can reconcile local\nfiles with the server's stored state.\n",
|
|
4469
|
+
);
|