Skip to content

Commit 8e11ebc

Browse files
committed
docs: bump to 2d9333091a1fc8c74219e466711761786444c25d
1 parent 3049637 commit 8e11ebc

File tree

1 file changed

+53
-8
lines changed

1 file changed

+53
-8
lines changed

docs/reference/api.json

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,6 +1282,14 @@
12821282
"type": "string",
12831283
"x-go-enum-desc": "link SelfServiceMessageVerificationStrategyLink\ncode SelfServiceMessageVerificationStrategyCode"
12841284
},
1285+
"kratos_selfservice_methods_captcha_config_cf_turnstile_sitekey": {
1286+
"description": "Configures the Turnstile site key for CAPTCHA protection\n\nThe site key is public and will be shared with the client.\n\nReach out to your account manager to enable this feature.",
1287+
"type": "string"
1288+
},
1289+
"kratos_selfservice_methods_captcha_enabled": {
1290+
"description": "Configures the Ory Kratos Self-Service Methods' Captcha Enabled Setting\n\nReach out to your account manager to enable this feature.",
1291+
"type": "boolean"
1292+
},
12851293
"kratos_selfservice_methods_code_config_lifespan": {
12861294
"description": "Configures the Ory Kratos Code Method's lifespan\n\nThis governs the \"selfservice.methods.code.config.lifespan\" setting.",
12871295
"type": "string"
@@ -3954,6 +3962,9 @@
39543962
},
39553963
"subject": {
39563964
"type": "string"
3965+
},
3966+
"use_auto_link": {
3967+
"type": "boolean"
39573968
}
39583969
},
39593970
"title": "CredentialsOIDCProvider is contains a specific OpenID COnnect credential for a particular connection (e.g. Google).",
@@ -4114,6 +4125,10 @@
41144125
"subject": {
41154126
"description": "The subject (`sub`) of the OpenID Connect connection. Usually the `sub` field of the ID Token.",
41164127
"type": "string"
4128+
},
4129+
"use_auto_link": {
4130+
"description": "If set, this credential allows the user to sign in using the OpenID Connect provider without setting the subject first.",
4131+
"type": "boolean"
41174132
}
41184133
},
41194134
"required": ["subject", "provider"],
@@ -5745,6 +5760,14 @@
57455760
"type": "string",
57465761
"x-go-enum-desc": "link SelfServiceMessageVerificationStrategyLink\ncode SelfServiceMessageVerificationStrategyCode"
57475762
},
5763+
"kratos_selfservice_methods_captcha_config_cf_turnstile_sitekey": {
5764+
"description": "Configures the Turnstile site key for CAPTCHA protection\n\nThe site key is public and will be shared with the client.\n\nReach out to your account manager to enable this feature.",
5765+
"type": "string"
5766+
},
5767+
"kratos_selfservice_methods_captcha_enabled": {
5768+
"description": "Configures the Ory Kratos Self-Service Methods' Captcha Enabled Setting\n\nReach out to your account manager to enable this feature.",
5769+
"type": "boolean"
5770+
},
57485771
"kratos_selfservice_methods_code_config_lifespan": {
57495772
"description": "Configures the Ory Kratos Code Method's lifespan\n\nThis governs the \"selfservice.methods.code.config.lifespan\" setting.",
57505773
"type": "string"
@@ -6350,7 +6373,7 @@
63506373
"description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.",
63516374
"properties": {
63526375
"access_token_strategy": {
6353-
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
6376+
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
63546377
"type": "string"
63556378
},
63566379
"allowed_cors_origins": {
@@ -6577,12 +6600,16 @@
65776600
"$ref": "#/components/schemas/StringSliceJSONFormat"
65786601
},
65796602
"challenge": {
6580-
"description": "ID is the identifier (\"authorization challenge\") of the consent authorization request. It is used to\nidentify the session.",
6603+
"description": "Challenge is used to retrieve/accept/deny the consent request.",
65816604
"type": "string"
65826605
},
65836606
"client": {
65846607
"$ref": "#/components/schemas/oAuth2Client"
65856608
},
6609+
"consent_request_id": {
6610+
"description": "ConsentRequestID is the ID of the consent request.",
6611+
"type": "string"
6612+
},
65866613
"context": {
65876614
"$ref": "#/components/schemas/JSONRawMessage"
65886615
},
@@ -6659,6 +6686,10 @@
66596686
"consent_request": {
66606687
"$ref": "#/components/schemas/oAuth2ConsentRequest"
66616688
},
6689+
"consent_request_id": {
6690+
"description": "ConsentRequestID is the identifier of the consent request that initiated this consent session.",
6691+
"type": "string"
6692+
},
66626693
"context": {
66636694
"$ref": "#/components/schemas/JSONRawMessage"
66646695
},
@@ -6722,7 +6753,7 @@
67226753
"oAuth2LoginRequest": {
67236754
"properties": {
67246755
"challenge": {
6725-
"description": "ID is the identifier (\"login challenge\") of the login request. It is used to\nidentify the session.",
6756+
"description": "ID is the identifier of the login request.",
67266757
"type": "string"
67276758
},
67286759
"client": {
@@ -6761,16 +6792,22 @@
67616792
"oAuth2LogoutRequest": {
67626793
"properties": {
67636794
"challenge": {
6764-
"description": "Challenge is the identifier (\"logout challenge\") of the logout authentication request. It is used to\nidentify the session.",
6795+
"description": "Challenge is the identifier of the logout authentication request.",
67656796
"type": "string"
67666797
},
67676798
"client": {
67686799
"$ref": "#/components/schemas/oAuth2Client"
67696800
},
6801+
"expires_at": {
6802+
"$ref": "#/components/schemas/nullTime"
6803+
},
67706804
"request_url": {
67716805
"description": "RequestURL is the original Logout URL requested.",
67726806
"type": "string"
67736807
},
6808+
"requested_at": {
6809+
"$ref": "#/components/schemas/nullTime"
6810+
},
67746811
"rp_initiated": {
67756812
"description": "RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client.",
67766813
"type": "boolean"
@@ -7989,7 +8026,7 @@
79898026
"type": "boolean"
79908027
},
79918028
"feature": {
7992-
"description": "\nproduction_projects ProductionProjects\nstaging_projects StagingProjects\ndevelopment_projects DevelopmentProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\nevent_streams EventStreams\nevent_stream_events EventStreamEvents\nsla SLA\ncollaborator_seats CollaboratorSeats\nedge_cache EdgeCache\nbranding_themes BrandingThemes\nzendesk_support ZendeskSupport\nproject_metrics ProjectMetrics\nproject_metrics_time_window ProjectMetricsTimeWindow\nproject_metrics_events_history ProjectMetricsEventsHistory\norganizations Organizations\nrop_grant ResourceOwnerPasswordGrant\nconcierge_onboarding ConciergeOnboarding\ncredit Credit\ndata_location_global DataLocationGlobal\ndata_location_us DataLocationUS\ndata_location_asiane DataLocationAsiaNorthEast\nm2m_token_issuance M2MTokenIssuance\npermission_checks PermissionChecks\ncaptcha Captcha\nsaml_sp SAMLSP\nsaml_idp SAMLIDP\ndata_location_regional DataLocationRegional Required Features\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList\npermission_checks_rate_limit_tier RateLimitTierPermissionChecks\noauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect\ncreate_recovery_admin_rate_limit_tier RateLimitTierCreateAdminRecovery",
8029+
"description": "\nproduction_projects ProductionProjects\nstaging_projects StagingProjects\ndevelopment_projects DevelopmentProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\nevent_streams EventStreams\nevent_stream_events EventStreamEvents\nsla SLA\ncollaborator_seats CollaboratorSeats\nedge_cache EdgeCache\nbranding_themes BrandingThemes\nzendesk_support ZendeskSupport\nproject_metrics ProjectMetrics\nproject_metrics_time_window ProjectMetricsTimeWindow\nproject_metrics_events_history ProjectMetricsEventsHistory\norganizations Organizations\nrop_grant ResourceOwnerPasswordGrant\nconcierge_onboarding ConciergeOnboarding\ncredit Credit\ndata_location_global DataLocationGlobal\ndata_location_us DataLocationUS\ndata_location_asiane DataLocationAsiaNorthEast\nm2m_token_issuance M2MTokenIssuance\npermission_checks PermissionChecks\ncaptcha Captcha\nsaml_sp SAMLSP\nsaml_idp SAMLIDP\nauto_link_policy AutoLinkPolicy\ndata_location_regional DataLocationRegional Required Features\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList\npermission_checks_rate_limit_tier RateLimitTierPermissionChecks\noauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect\ncreate_recovery_admin_rate_limit_tier RateLimitTierCreateAdminRecovery",
79938030
"enum": [
79948031
"production_projects",
79958032
"staging_projects",
@@ -8018,6 +8055,7 @@
80188055
"captcha",
80198056
"saml_sp",
80208057
"saml_idp",
8058+
"auto_link_policy",
80218059
"data_location_regional",
80228060
"rate_limit_tier",
80238061
"session_rate_limit_tier",
@@ -8027,7 +8065,7 @@
80278065
"create_recovery_admin_rate_limit_tier"
80288066
],
80298067
"type": "string",
8030-
"x-go-enum-desc": "production_projects ProductionProjects\nstaging_projects StagingProjects\ndevelopment_projects DevelopmentProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\nevent_streams EventStreams\nevent_stream_events EventStreamEvents\nsla SLA\ncollaborator_seats CollaboratorSeats\nedge_cache EdgeCache\nbranding_themes BrandingThemes\nzendesk_support ZendeskSupport\nproject_metrics ProjectMetrics\nproject_metrics_time_window ProjectMetricsTimeWindow\nproject_metrics_events_history ProjectMetricsEventsHistory\norganizations Organizations\nrop_grant ResourceOwnerPasswordGrant\nconcierge_onboarding ConciergeOnboarding\ncredit Credit\ndata_location_global DataLocationGlobal\ndata_location_us DataLocationUS\ndata_location_asiane DataLocationAsiaNorthEast\nm2m_token_issuance M2MTokenIssuance\npermission_checks PermissionChecks\ncaptcha Captcha\nsaml_sp SAMLSP\nsaml_idp SAMLIDP\ndata_location_regional DataLocationRegional Required Features\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList\npermission_checks_rate_limit_tier RateLimitTierPermissionChecks\noauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect\ncreate_recovery_admin_rate_limit_tier RateLimitTierCreateAdminRecovery"
8068+
"x-go-enum-desc": "production_projects ProductionProjects\nstaging_projects StagingProjects\ndevelopment_projects DevelopmentProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\nevent_streams EventStreams\nevent_stream_events EventStreamEvents\nsla SLA\ncollaborator_seats CollaboratorSeats\nedge_cache EdgeCache\nbranding_themes BrandingThemes\nzendesk_support ZendeskSupport\nproject_metrics ProjectMetrics\nproject_metrics_time_window ProjectMetricsTimeWindow\nproject_metrics_events_history ProjectMetricsEventsHistory\norganizations Organizations\nrop_grant ResourceOwnerPasswordGrant\nconcierge_onboarding ConciergeOnboarding\ncredit Credit\ndata_location_global DataLocationGlobal\ndata_location_us DataLocationUS\ndata_location_asiane DataLocationAsiaNorthEast\nm2m_token_issuance M2MTokenIssuance\npermission_checks PermissionChecks\ncaptcha Captcha\nsaml_sp SAMLSP\nsaml_idp SAMLIDP\nauto_link_policy AutoLinkPolicy\ndata_location_regional DataLocationRegional Required Features\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList\npermission_checks_rate_limit_tier RateLimitTierPermissionChecks\noauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect\ncreate_recovery_admin_rate_limit_tier RateLimitTierCreateAdminRecovery"
80318069
},
80328070
"feature_available": {
80338071
"type": "boolean"
@@ -12879,7 +12917,6 @@
1287912917
"description": "OAuth 2.0 Consent Subject\n\nThe subject whose consent sessions should be deleted.",
1288012918
"in": "query",
1288112919
"name": "subject",
12882-
"required": true,
1288312920
"schema": {
1288412921
"type": "string"
1288512922
}
@@ -12892,6 +12929,14 @@
1289212929
"type": "string"
1289312930
}
1289412931
},
12932+
{
12933+
"description": "Consent Request ID\n\nIf set, revoke all token chains derived from this particular consent request ID.",
12934+
"in": "query",
12935+
"name": "consent_request_id",
12936+
"schema": {
12937+
"type": "string"
12938+
}
12939+
},
1289512940
{
1289612941
"description": "Revoke All Consent Sessions\n\nIf set to `true` deletes all consent sessions by the Subject that have been granted.",
1289712942
"in": "query",
@@ -13001,7 +13046,7 @@
1300113046
},
1300213047
"/admin/oauth2/auth/sessions/login": {
1300313048
"delete": {
13004-
"description": "This endpoint invalidates authentication sessions. After revoking the authentication session(s), the subject\nhas to re-authenticate at the Ory OAuth2 Provider. This endpoint does not invalidate any tokens.\n\nIf you send the subject in a query param, all authentication sessions that belong to that subject are revoked.\nNo OpenID Connect Front- or Back-channel logout is performed in this case.\n\nAlternatively, you can send a SessionID via `sid` query param, in which case, only the session that is connected\nto that SessionID is revoked. OpenID Connect Back-channel logout is performed in this case.",
13049+
"description": "This endpoint invalidates authentication sessions. After revoking the authentication session(s), the subject\nhas to re-authenticate at the Ory OAuth2 Provider. This endpoint does not invalidate any tokens.\n\nIf you send the subject in a query param, all authentication sessions that belong to that subject are revoked.\nNo OpenID Connect Front- or Back-channel logout is performed in this case.\n\nAlternatively, you can send a SessionID via `sid` query param, in which case, only the session that is connected\nto that SessionID is revoked. OpenID Connect Back-channel logout is performed in this case.\n\nWhen using Ory for the identity provider, the login provider will also invalidate the session cookie.",
1300513050
"operationId": "revokeOAuth2LoginSessions",
1300613051
"parameters": [
1300713052
{

0 commit comments

Comments
 (0)