|
392 | 392 | },
|
393 | 393 | "optional": {
|
394 | 394 | "type": "boolean",
|
395 |
| - "description": "`optional` determines whether an email address must be provided when an input for this identifier is available.\nIf set to `true` this action can be skipped.", |
| 395 | + "description": "`optional` determines whether users must provide an email when prompted.\nThere must always be at least one email address associated with an account. The primary email address cannot be\ndeleted if emails are required (`optional`: false`).", |
396 | 396 | "default": true
|
397 | 397 | },
|
398 | 398 | "passcode_ttl": {
|
|
627 | 627 | },
|
628 | 628 | "optional": {
|
629 | 629 | "type": "boolean",
|
630 |
| - "description": "`optional` determines whether users must have registered at least one passkey. It controls whether passkey\ncreation can be skipped if prompted for. It also takes part in determining\nthe order of passkey and password acquisition on login and registration (see also `acquire_on_login` and\n`acquire_on_registration`).", |
| 630 | + "description": "`optional` determines whether users must create a passkey when prompted. The last remaining passkey cannot be\ndeleted if passkeys are required (`optional: false`).\n\nIt also takes part in determining the order of password and passkey acquisition\non login and registration (see also `acquire_on_login` and `acquire_on_registration`): if one credential type is\nrequired (`optional: false`) then that one takes precedence, i.e. is acquired first.", |
631 | 631 | "default": true
|
632 | 632 | },
|
633 | 633 | "user_verification": {
|
|
698 | 698 | },
|
699 | 699 | "optional": {
|
700 | 700 | "type": "boolean",
|
701 |
| - "description": "`optional` determines whether users must have a password set. It controls whether password creation can be\nskipped if prompted for. It also takes part in determining the order of password and passkey acquisition\non login and registration (see also `acquire_on_login` and `acquire_on_registration`).", |
| 701 | + "description": "`optional` determines whether users must set a password when prompted. The password cannot be deleted if\npasswords are required (`optional: false`).\n\nIt also takes part in determining the order of password and passkey acquisition\non login and registration (see also `acquire_on_login` and `acquire_on_registration`): if one credential type is\nrequired (`optional: false`) then that one takes precedence, i.e. is acquired first.", |
702 | 702 | "default": false
|
703 | 703 | },
|
704 | 704 | "recovery": {
|
|
732 | 732 | },
|
733 | 733 | "passcode_limits": {
|
734 | 734 | "$ref": "#/$defs/RateLimits",
|
735 |
| - "description": "`passcode_limits` controls rate limits specific to the password/login endpoint." |
| 735 | + "description": "`passcode_limits` controls rate limits for passcode operations." |
736 | 736 | },
|
737 | 737 | "password_limits": {
|
738 | 738 | "$ref": "#/$defs/RateLimits",
|
739 |
| - "description": "`password_limits` controls rate limits specific to the password/login endpoint." |
| 739 | + "description": "`password_limits` controls rate limits for password login operations." |
740 | 740 | },
|
741 | 741 | "token_limits": {
|
742 | 742 | "$ref": "#/$defs/RateLimits",
|
743 |
| - "description": "`token_limits` controls rate limits specific to the token endpoint." |
| 743 | + "description": "`token_limits` controls rate limits for token exchange operations." |
744 | 744 | }
|
745 | 745 | },
|
746 | 746 | "additionalProperties": false,
|
|
801 | 801 | },
|
802 | 802 | "type": "array",
|
803 | 803 | "minItems": 1,
|
804 |
| - "description": "`origins` is a list of origins for which passkeys/WebAuthn credentials will be accepted by the server. Must\ninclude the protocol and can only be the effective domain, or a registrable domain suffix of the effective\ndomain, as specified in the [`id`](#id). Except for `localhost`, the protocol **must** always be `https` for\npasskeys/ WebAuthn to work. IP Addresses will not work.\n\nFor an Android application the origin must be the base64 url encoded SHA256 fingerprint of the signing\ncertificate.", |
| 804 | + "description": "`origins` is a list of origins for which passkeys/WebAuthn credentials will be accepted by the server. Must\ninclude the protocol and can only be the effective domain, or a registrable domain suffix of the effective\ndomain, as specified in the [`id`](#id). Except for `localhost`, the protocol **must** always be `https` for\npasskeys/WebAuthn to work. IP Addresses will not work.\n\nFor an Android application the origin must be the base64 url encoded SHA256 fingerprint of the signing\ncertificate.", |
805 | 805 | "default": [
|
806 | 806 | "http://localhost:8888"
|
807 | 807 | ]
|
|
917 | 917 | "properties": {
|
918 | 918 | "name": {
|
919 | 919 | "type": "string",
|
920 |
| - "description": "`service` determines the name of the service.\nThis value will is used, e.g. in the subject header of outgoing emails." |
| 920 | + "description": "`name` determines the name of the service.\nThis value is used, e.g. in the subject header of outgoing emails." |
921 | 921 | }
|
922 | 922 | },
|
923 | 923 | "additionalProperties": false,
|
|
970 | 970 | },
|
971 | 971 | "error_redirect_url": {
|
972 | 972 | "type": "string",
|
973 |
| - "description": "`error_redirect_url` is the URL the backend redirects to if an error occurs during third party sign-in.\nErrors are provided as 'error' and 'error_description' query params in the redirect location URL.\n\nWhen using the Hanko web components it should be the URL of the page that embeds the web component such that\nerrors can be processed properly by the web component.\n\nYou do not have to add this URL to the 'allowed_redirect_urls', it is automatically included when validating\nredirect URLs.\n\nRequired if any of the [`providers`](#providers) are `enabled`. Must not have trailing slash." |
| 973 | + "description": "`error_redirect_url` is the URL the backend redirects to if an error occurs during third party sign-in.\nErrors are provided as 'error' and 'error_description' query params in the redirect location URL.\n\nWhen using the Hanko web components it should be the URL of the page that embeds the web component such that\nerrors can be processed properly by the web component.\n\nYou do not have to add this URL to the 'allowed_redirect_urls', it is automatically included when validating\nredirect URLs.\n\nRequired if any of the [`providers`](#providers) are `enabled`. Must not have trailing slash." |
974 | 974 | },
|
975 | 975 | "default_redirect_url": {
|
976 | 976 | "type": "string",
|
|
1009 | 1009 | "properties": {
|
1010 | 1010 | "allow_linking": {
|
1011 | 1011 | "type": "boolean",
|
1012 |
| - "description": "`allow_linking` indicates whether existing accounts can be automatically linked with this provider." |
| 1012 | + "description": "`allow_linking` indicates whether existing accounts can be automatically linked with this provider.\n\nLinking is based on matching one of the email addresses of an existing user account with the (primary)\nemail address of the third party provider account." |
1013 | 1013 | },
|
1014 | 1014 | "client_id": {
|
1015 | 1015 | "type": "string",
|
|
1033 | 1033 | "properties": {
|
1034 | 1034 | "apple": {
|
1035 | 1035 | "$ref": "#/$defs/ThirdPartyProvider",
|
1036 |
| - "description": "`apple` contains the provider configuration for Sign in with Apple." |
| 1036 | + "description": "`apple` contains the provider configuration for Apple." |
1037 | 1037 | },
|
1038 | 1038 | "discord": {
|
1039 | 1039 | "$ref": "#/$defs/ThirdPartyProvider",
|
|
1088 | 1088 | },
|
1089 | 1089 | "optional": {
|
1090 | 1090 | "type": "boolean",
|
1091 |
| - "description": "`optional` determines whether a username must be provided when an input for this identifier is available.\nIf set to `true` this action can be skipped.", |
| 1091 | + "description": "`optional` determines whether users must provide a username when prompted. The username can only be changed but\nnot deleted if usernames are required (`optional: false`).", |
1092 | 1092 | "default": true
|
1093 | 1093 | },
|
1094 | 1094 | "use_as_login_identifier": {
|
|
0 commit comments