You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**defaultRegion**|[**DefaultRegionEnum**](#DefaultRegionEnum)| DefaultRegion sets the default region for identities provisioned into this organization, when the identity does not specify a region explictly. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global |[optional]|
10
11
|**domains**|**List<String>**| The list of organization's domains. ||
11
12
|**id**|**String**| The organization's ID. ||
12
13
|**label**|**String**| The organization's human-readable label. ||
Copy file name to clipboardExpand all lines: docs/CreateIdentityBody.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,13 +14,29 @@ Create Identity Body
14
14
|**metadataPublic**|**Object**| Store metadata about the identity which the identity itself can see when calling for example the session endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field. |[optional]|
15
15
|**organizationId**|**String**||[optional]|
16
16
|**recoveryAddresses**|[**List<RecoveryIdentityAddress>**](RecoveryIdentityAddress.md)| RecoveryAddresses contains all the addresses that can be used to recover an identity. Use this structure to import recovery addresses for an identity. Please keep in mind that the address needs to be represented in the Identity Schema or this field will be overwritten on the next identity update. |[optional]|
17
+
|**region**|[**RegionEnum**](#RegionEnum)| Region is the Ory Network region this identity will be created in. Optional; defaults to the project home region if omitted. Only effective on the Ory Network. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global |[optional]|
17
18
|**schemaId**|**String**| SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. ||
18
19
|**state**|[**StateEnum**](#StateEnum)| State is the identity's state. active StateActive inactive StateInactive |[optional]|
19
20
|**traits**|**Object**| Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_url`. ||
20
21
|**verifiableAddresses**|[**List<VerifiableIdentityAddress>**](VerifiableIdentityAddress.md)| VerifiableAddresses contains all the addresses that can be verified by the user. Use this structure to import verified addresses for an identity. Please keep in mind that the address needs to be represented in the Identity Schema or this field will be overwritten on the next identity update. |[optional]|
|**environment**|[**EnvironmentEnum**](#EnvironmentEnum)| The environment of the project. prod Production stage Staging dev Development ||
12
-
|**homeRegion**|[**HomeRegionEnum**](#HomeRegionEnum)| Home Region The home region of the project. This is the region where the project will be created. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest us US global Global |[optional]|
12
+
|**homeRegion**|[**HomeRegionEnum**](#HomeRegionEnum)| Home Region The home region of the project. This is the region where the project will be created. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global |[optional]|
13
13
|**name**|**String**| The name of the project to be created ||
14
14
|**workspaceId**|**String**| The workspace to create the project in. |[optional]|
|**accountExperienceEnabledLocales**|**List<String>**| The Account Experience's Enabled Locales This governs the locales that are available in the account experience. This governs the \"enabled_locales\" setting. |[optional]|
14
14
|**accountExperienceFaviconDark**|**String**| Holds the URL to the account experience's dark theme favicon (currently unused). This governs the \"favicon_dark\" setting. |[optional]|
15
15
|**accountExperienceFaviconLight**|**String**| Holds the URL to the account experience's favicon. This governs the \"favicon_light\" setting. |[optional]|
16
+
|**accountExperienceHideOryBranding**|**Boolean**| Whether to hide the Ory branding badge on the account experience. This governs the \"hide_ory_branding\" setting. |[optional]|
17
+
|**accountExperienceHideRegistrationLink**|**Boolean**| Whether to hide the registration link on the account experience login card. This governs the \"hide_registration_link\" setting. |[optional]|
16
18
|**accountExperienceLocaleBehavior**|**String**| Holds the URL to the account experience's language behavior. Can be one of: `respect_accept_language`: Respect the `Accept-Language` header. `force_default`: Force the default language. This governs the \"locale_behavior\" setting. |[optional]|
17
19
|**accountExperienceLogoDark**|**String**| Holds the URL to the account experience's dark theme logo (currently unused). This governs the \"logo_dark\" setting. |[optional]|
18
20
|**accountExperienceLogoLight**|**String**| Holds the URL to the account experience's logo. This governs the \"logo_light\" setting. |[optional]|
|**disableAccountExperienceWelcomeScreen**|**Boolean**| Whether to disable the account experience welcome screen, which is hosted under `/ui/welcome`. This governs the \"disable_welcome_screen\" setting. |[optional]|
23
25
|**enableAxV2**|**Boolean**| Whether the new account experience is enabled and reachable. This governs the \"enable_ax_v2\" setting. |[optional]|
24
26
|**environment**|[**EnvironmentEnum**](#EnvironmentEnum)| prod Production stage Staging dev Development ||
25
-
|**homeRegion**|[**HomeRegionEnum**](#HomeRegionEnum)| eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest us US global Global |[optional]|
27
+
|**homeRegion**|[**HomeRegionEnum**](#HomeRegionEnum)| eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global |[optional]|
26
28
|**hydraOauth2AllowedTopLevelClaims**|**List<String>**| A list of custom claims which are allowed to be added top level to the Access Token. They cannot override reserved claims. This governs the \"oauth2.allowed_top_level_claims\" setting. |[optional]|
27
29
|**hydraOauth2ClientCredentialsDefaultGrantAllowedScope**|**Boolean**| Automatically grant authorized OAuth2 Scope in OAuth2 Client Credentials Flow. Each OAuth2 Client is allowed to request a predefined OAuth2 Scope (for example `read write`). If this option is enabled, the full scope is automatically granted when performing the OAuth2 Client Credentials flow. If disabled, the OAuth2 Client has to request the scope in the OAuth2 request by providing the `scope` query parameter. Setting this option to true is common if you need compatibility with MITREid. This governs the \"oauth2.client_credentials.default_grant_allowed_scope\" setting. |[optional]|
28
30
|**hydraOauth2ExcludeNotBeforeClaim**|**Boolean**| Set to true if you want to exclude claim `nbf (not before)` part of access token. This governs the \"oauth2.exclude_not_before_claim\" setting. |[optional]|
Copy file name to clipboardExpand all lines: docs/Identity.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) repr
16
16
|**metadataPublic**|**Object**| NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- |[optional]|
17
17
|**organizationId**|**String**||[optional]|
18
18
|**recoveryAddresses**|[**List<RecoveryIdentityAddress>**](RecoveryIdentityAddress.md)| RecoveryAddresses contains all the addresses that can be used to recover an identity. |[optional]|
19
+
|**region**|[**RegionEnum**](#RegionEnum)| Region is the Ory Network region this identity is homed in. Set by the multi-region persister; empty on OSS and single-region deployments. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global |[optional]|
19
20
|**schemaId**|**String**| SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. ||
20
21
|**schemaUrl**|**String**| SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url ||
21
22
|**state**|[**StateEnum**](#StateEnum)| State is the identity's state. This value has currently no effect. active StateActive inactive StateInactive |[optional]|
@@ -26,6 +27,21 @@ An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) repr
|**environment**|[**EnvironmentEnum**](#EnvironmentEnum)| The environment of the project. prod Production stage Staging dev Development ||
13
-
|**homeRegion**|[**HomeRegionEnum**](#HomeRegionEnum)| The project's data home region. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest us US global Global |[readonly]|
13
+
|**homeRegion**|[**HomeRegionEnum**](#HomeRegionEnum)| The project's data home region. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest eu EU asia Asia us US global Global |[readonly]|
14
14
|**hosts**|**List<String>**| The FQDN hostnames this project listens on ||
15
15
|**id**|**String**| The project's ID. |[readonly]|
16
16
|**slug**|**String**| The project's slug |[readonly]|
0 commit comments