Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
@Chistousov
Chistousov authored Jan 11, 2024
2 parents 466907d + 9b86ed7 commit 4983b08
Showing 1 changed file with 180 additions and 19 deletions.
199 changes: 180 additions & 19 deletions docs/reference/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,74 @@
"required": ["workspaces", "next_page_token", "has_next_page"],
"type": "object"
},
"NormalizedProjectRevisionCourierChannel": {
"properties": {
"channel_id": {
"description": "The Channel's public ID",
"type": "string"
},
"created_at": {
"description": "The creation date",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"request_config_auth_config_api_key_in": {
"description": "API key location\n\nCan either be \"header\" or \"query\"",
"example": "header",
"type": "string"
},
"request_config_auth_config_api_key_name": {
"description": "API key name\n\nOnly used if the auth type is api_key",
"type": "string"
},
"request_config_auth_config_api_key_value": {
"description": "API key value\n\nOnly used if the auth type is api_key",
"type": "string"
},
"request_config_auth_config_basic_auth_password": {
"description": "Basic Auth Password\n\nOnly used if the auth type is basic_auth",
"type": "string"
},
"request_config_auth_config_basic_auth_user": {
"description": "Basic Auth Username\n\nOnly used if the auth type is basic_auth",
"type": "string"
},
"request_config_auth_type": {
"description": "HTTP Auth Method to use for the HTTP call\n\nCan either be basic_auth or api_key\nbasic_auth CourierChannelAuthTypeBasicAuth\napi_key CourierChannelAuthTypeApiKey",
"enum": ["basic_auth", "api_key"],
"type": "string",
"x-go-enum-desc": "basic_auth CourierChannelAuthTypeBasicAuth\napi_key CourierChannelAuthTypeApiKey"
},
"request_config_body": {
"description": "URI pointing to the JsonNet template used for HTTP body payload generation.",
"type": "string"
},
"request_config_headers": {
"$ref": "#/components/schemas/nullJsonRawMessage"
},
"request_config_method": {
"description": "The HTTP method to use (GET, POST, etc) for the HTTP call",
"example": "POST",
"type": "string"
},
"request_config_url": {
"type": "string"
},
"updated_at": {
"description": "Last upate time",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"channel_id",
"request_config_method",
"request_config_body"
],
"type": "object"
},
"NullBool": {
"nullable": true,
"type": "boolean"
Expand Down Expand Up @@ -910,6 +978,26 @@
},
"type": "object"
},
"createEventStreamBody": {
"description": "Create Event Stream Request Body",
"properties": {
"role_arn": {
"description": "The AWS IAM role ARN to assume when publishing to the SNS topic.",
"type": "string"
},
"topic_arn": {
"description": "The AWS SNS topic ARN.",
"type": "string"
},
"type": {
"description": "The type of the event stream (AWS SNS, GCP Pub/Sub, etc).",
"enum": ["sns"],
"type": "string"
}
},
"required": ["type", "topic_arn", "role_arn"],
"type": "object"
},
"createIdentityBody": {
"description": "Create Identity Body",
"properties": {
Expand Down Expand Up @@ -1217,6 +1305,9 @@
"description": "Configures the Ory Kratos Cookie SameSite Attribute\n\nThis governs the \"cookies.same_site\" setting.",
"type": "string"
},
"kratos_courier_channels": {
"$ref": "#/components/schemas/revisionCourierChannels"
},
"kratos_courier_delivery_strategy": {
"default": "smtp",
"description": "The delivery strategy to use when sending emails\n\n`smtp`: Use SMTP server\n`http`: Use the built in HTTP client to send the email to some remote service",
Expand Down Expand Up @@ -1378,6 +1469,10 @@
"description": "Configures the Ory Kratos Valid Verification via Code Email Subject Template\n\nThis governs the \"courier.smtp.templates.verification_code.valid.email.subject\" setting.",
"type": "string"
},
"kratos_courier_templates_verification_code_valid_sms_body_plaintext": {
"description": "Configures the Ory Kratos Valid Verification via Code SMS Body Plaintext\n\nThis governs the \"courier.smtp.templates.verification_code.valid.sms.body.plaintext\" setting.",
"type": "string"
},
"kratos_courier_templates_verification_invalid_email_body_html": {
"description": "Configures the Ory Kratos Invalid Verification Email Body HTML Template\n\nThis governs the \"courier.smtp.templates.verification.invalid.email.body.html\" setting.",
"type": "string"
Expand Down Expand Up @@ -2090,6 +2185,33 @@
},
"type": "object"
},
"eventStream": {
"description": "Event Stream",
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"role_arn": {
"type": "string"
},
"topic_arn": {
"type": "string"
},
"type": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"expandedPermissionTree": {
"properties": {
"children": {
Expand Down Expand Up @@ -2674,10 +2796,6 @@
"description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema",
"type": "string"
},
"identityVerifiableAddressType": {
"description": "VerifiableAddressType must not exceed 16 characters as that is the limitation in the SQL Schema",
"type": "string"
},
"identityWithCredentials": {
"description": "Create Identity and Import Credentials",
"properties": {
Expand Down Expand Up @@ -3057,6 +3175,18 @@
},
"type": "array"
},
"listEventStreams": {
"description": "Event Stream List",
"properties": {
"event_streams": {
"items": {
"$ref": "#/components/schemas/eventStream"
},
"type": "array"
}
},
"type": "object"
},
"listOrganizationsResponse": {
"description": "B2B SSO Organization List",
"properties": {
Expand Down Expand Up @@ -3318,6 +3448,9 @@
"body": {
"type": "string"
},
"channel": {
"type": "string"
},
"created_at": {
"description": "CreatedAt is a helper struct field for gobuffalo.pop.",
"format": "date-time",
Expand Down Expand Up @@ -3348,7 +3481,7 @@
"type": "string"
},
"template_type": {
"description": "\nrecovery_invalid TypeRecoveryInvalid\nrecovery_valid TypeRecoveryValid\nrecovery_code_invalid TypeRecoveryCodeInvalid\nrecovery_code_valid TypeRecoveryCodeValid\nverification_invalid TypeVerificationInvalid\nverification_valid TypeVerificationValid\nverification_code_invalid TypeVerificationCodeInvalid\nverification_code_valid TypeVerificationCodeValid\notp TypeOTP\nstub TypeTestStub\nlogin_code_valid TypeLoginCodeValid\nregistration_code_valid TypeRegistrationCodeValid",
"description": "\nrecovery_invalid TypeRecoveryInvalid\nrecovery_valid TypeRecoveryValid\nrecovery_code_invalid TypeRecoveryCodeInvalid\nrecovery_code_valid TypeRecoveryCodeValid\nverification_invalid TypeVerificationInvalid\nverification_valid TypeVerificationValid\nverification_code_invalid TypeVerificationCodeInvalid\nverification_code_valid TypeVerificationCodeValid\nstub TypeTestStub\nlogin_code_valid TypeLoginCodeValid\nregistration_code_valid TypeRegistrationCodeValid",
"enum": [
"recovery_invalid",
"recovery_valid",
Expand All @@ -3358,13 +3491,12 @@
"verification_valid",
"verification_code_invalid",
"verification_code_valid",
"otp",
"stub",
"login_code_valid",
"registration_code_valid"
],
"type": "string",
"x-go-enum-desc": "recovery_invalid TypeRecoveryInvalid\nrecovery_valid TypeRecoveryValid\nrecovery_code_invalid TypeRecoveryCodeInvalid\nrecovery_code_valid TypeRecoveryCodeValid\nverification_invalid TypeVerificationInvalid\nverification_valid TypeVerificationValid\nverification_code_invalid TypeVerificationCodeInvalid\nverification_code_valid TypeVerificationCodeValid\notp TypeOTP\nstub TypeTestStub\nlogin_code_valid TypeLoginCodeValid\nregistration_code_valid TypeRegistrationCodeValid"
"x-go-enum-desc": "recovery_invalid TypeRecoveryInvalid\nrecovery_valid TypeRecoveryValid\nrecovery_code_invalid TypeRecoveryCodeInvalid\nrecovery_code_valid TypeRecoveryCodeValid\nverification_invalid TypeVerificationInvalid\nverification_valid TypeVerificationValid\nverification_code_invalid TypeVerificationCodeInvalid\nverification_code_valid TypeVerificationCodeValid\nstub TypeTestStub\nlogin_code_valid TypeLoginCodeValid\nregistration_code_valid TypeRegistrationCodeValid"
},
"type": {
"$ref": "#/components/schemas/courierMessageType"
Expand Down Expand Up @@ -3737,6 +3869,9 @@
"description": "Configures the Ory Kratos Cookie SameSite Attribute\n\nThis governs the \"cookies.same_site\" setting.",
"type": "string"
},
"kratos_courier_channels": {
"$ref": "#/components/schemas/revisionCourierChannels"
},
"kratos_courier_delivery_strategy": {
"default": "smtp",
"description": "The delivery strategy to use when sending emails\n\n`smtp`: Use SMTP server\n`http`: Use the built in HTTP client to send the email to some remote service",
Expand Down Expand Up @@ -3898,6 +4033,10 @@
"description": "Configures the Ory Kratos Valid Verification via Code Email Subject Template\n\nThis governs the \"courier.smtp.templates.verification_code.valid.email.subject\" setting.",
"type": "string"
},
"kratos_courier_templates_verification_code_valid_sms_body_plaintext": {
"description": "Configures the Ory Kratos Valid Verification via Code SMS Body Plaintext\n\nThis governs the \"courier.smtp.templates.verification_code.valid.sms.body.plaintext\" setting.",
"type": "string"
},
"kratos_courier_templates_verification_invalid_email_body_html": {
"description": "Configures the Ory Kratos Invalid Verification Email Body HTML Template\n\nThis governs the \"courier.smtp.templates.verification.invalid.email.body.html\" setting.",
"type": "string"
Expand Down Expand Up @@ -5035,15 +5174,7 @@
"type": "string"
}
},
"required": [
"challenge",
"requested_scope",
"requested_access_token_audience",
"skip",
"subject",
"client",
"request_url"
],
"required": ["challenge", "skip", "subject", "client", "request_url"],
"title": "Contains information on an ongoing login request.",
"type": "object"
},
Expand Down Expand Up @@ -6181,7 +6312,7 @@
"type": "boolean"
},
"feature": {
"description": "\nregion_eu RegionEU\nregion_us RegionUS\nregion_apac RegionAPAC\nregion_global RegionGlobal\nproduction_projects ProductionProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\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\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList",
"description": "\nregion_eu RegionEU\nregion_us RegionUS\nregion_apac RegionAPAC\nregion_global RegionGlobal\nproduction_projects ProductionProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\nevent_streams EventStreams\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\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList",
"enum": [
"region_eu",
"region_us",
Expand All @@ -6190,6 +6321,7 @@
"production_projects",
"daily_active_users",
"custom_domains",
"event_streams",
"sla",
"collaborator_seats",
"edge_cache",
Expand All @@ -6205,7 +6337,7 @@
"identities_list_rate_limit_tier"
],
"type": "string",
"x-go-enum-desc": "region_eu RegionEU\nregion_us RegionUS\nregion_apac RegionAPAC\nregion_global RegionGlobal\nproduction_projects ProductionProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\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\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList"
"x-go-enum-desc": "region_eu RegionEU\nregion_us RegionUS\nregion_apac RegionAPAC\nregion_global RegionGlobal\nproduction_projects ProductionProjects\ndaily_active_users DailyActiveUsers\ncustom_domains CustomDomains\nevent_streams EventStreams\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\nrate_limit_tier RateLimitTier\nsession_rate_limit_tier RateLimitTierSessions\nidentities_list_rate_limit_tier RateLimitTierIdentitiesList"
},
"feature_available": {
"type": "boolean"
Expand Down Expand Up @@ -6549,6 +6681,12 @@
},
"type": "object"
},
"revisionCourierChannels": {
"items": {
"$ref": "#/components/schemas/NormalizedProjectRevisionCourierChannel"
},
"type": "array"
},
"schemaPatch": {
"properties": {
"data": {
Expand Down Expand Up @@ -6751,6 +6889,26 @@
},
"type": "object"
},
"setEventStreamBody": {
"description": "Update Event Stream Body",
"properties": {
"role_arn": {
"description": "The AWS IAM role ARN to assume when publishing to the SNS topic.",
"type": "string"
},
"topic_arn": {
"description": "The AWS SNS topic ARN.",
"type": "string"
},
"type": {
"description": "The type of the event stream (AWS SNS, GCP Pub/Sub, etc).",
"enum": ["sns"],
"type": "string"
}
},
"required": ["type", "topic_arn", "role_arn"],
"type": "object"
},
"setProject": {
"properties": {
"cors_admin": {
Expand Down Expand Up @@ -8321,7 +8479,10 @@
"$ref": "#/components/schemas/nullTime"
},
"via": {
"$ref": "#/components/schemas/identityVerifiableAddressType"
"description": "The delivery method",
"enum": ["email", "sms"],
"example": "email",
"type": "string"
}
},
"required": ["value", "verified", "via", "status"],
Expand Down

0 comments on commit 4983b08

Please sign in to comment.