--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # azure_ad_application{% #azure_ad_application %} ## `add_ins`{% #add_ins %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `addIns`**Description**: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams can set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for the addIn object. - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The unique name for the functionality exposed by the app. ## `api`{% #api %} **Type**: `STRUCT`**Provider name**: `api`**Description**: Specifies settings for an application that implements a web API. - `accept_mapped_claims`**Type**: `BOOLEAN`**Provider name**: `acceptMappedClaims`**Description**: When true, allows an application to use claims mapping without specifying a custom signing key. - `known_client_applications`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `knownClientApplications`**Description**: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Microsoft Entra ID knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. - `oauth2_permission_scopes`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `oauth2PermissionScopes`**Description**: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. - `admin_consent_description`**Type**: `STRING`**Provider name**: `adminConsentDescription`**Description**: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. - `admin_consent_display_name`**Type**: `STRING`**Provider name**: `adminConsentDisplayName`**Description**: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. - `is_enabled`**Type**: `BOOLEAN`**Provider name**: `isEnabled`**Description**: When you create or update a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. - `origin`**Type**: `STRING`**Provider name**: `origin` - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The possible values are: User and Admin. Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required. While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission). For more information, see Configure how users consent to applications. - `user_consent_description`**Type**: `STRING`**Provider name**: `userConsentDescription`**Description**: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. - `user_consent_display_name`**Type**: `STRING`**Provider name**: `userConsentDisplayName`**Description**: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren't allowed. May not begin with .. - `pre_authorized_applications`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `preAuthorizedApplications`**Description**: Lists the client applications that are preauthorized with the specified delegated permissions to access this application's APIs. Users aren't required to consent to any preauthorized application (for the permissions specified). However, any other permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. - `app_id`**Type**: `STRING`**Provider name**: `appId`**Description**: The unique identifier for the application. - `delegated_permission_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `delegatedPermissionIds`**Description**: The unique identifier for the oauth2PermissionScopes the application requires. - `requested_access_token_version`**Type**: `INT64`**Provider name**: `requestedAccessTokenVersion`**Description**: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount, the value for this property must be 2. ## `app_id`{% #app_id %} **Type**: `STRING`**Provider name**: `appId`**Description**: The unique identifier for the application that is assigned to an application by Microsoft Entra ID. Not nullable. Read-only. Alternate key. Supports $filter (eq). ## `app_management_policies`{% #app_management_policies %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `appManagementPolicies`**Description**: The appManagementPolicy applied to this application. - `applies_to`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `appliesTo`**Description**: Collection of applications and service principals to which the policy is applied. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `is_enabled`**Type**: `BOOLEAN`**Provider name**: `isEnabled`**Description**: Denotes whether the policy is enabled. - `name`**Type**: `STRING`**Provider name**: `name` - `restrictions`**Type**: `STRUCT`**Provider name**: `restrictions`**Description**: Restrictions that apply to an application or service principal object. - `name`**Type**: `STRING`**Provider name**: `name` - `key_credentials`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `keyCredentials`**Description**: Collection of keyCredential restrictions settings to be applied to an application or service principal. - `max_lifetime`**Type**: `STRING`**Provider name**: `maxLifetime`**Description**: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime. - `restrict_for_apps_created_after_date_time`**Type**: `STRING`**Provider name**: `restrictForAppsCreatedAfterDateTime`**Description**: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied. - `restriction_type`**Type**: `STRING`**Provider name**: `restrictionType`**Description**: The type of restriction being applied. Possible values are asymmetricKeyLifetime, and unknownFutureValue. Each value of restrictionType can be used only once per policy. - `state`**Type**: `STRING`**Provider name**: `state` - `password_credentials`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `passwordCredentials`**Description**: Collection of password restrictions settings to be applied to an application or service principal. - `max_lifetime`**Type**: `STRING`**Provider name**: `maxLifetime`**Description**: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime. - `restrict_for_apps_created_after_date_time`**Type**: `STRING`**Provider name**: `restrictForAppsCreatedAfterDateTime`**Description**: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied. - `restriction_type`**Type**: `STRING`**Provider name**: `restrictionType`**Description**: The type of restriction being applied. The possible values are: passwordAddition, passwordLifetime, symmetricKeyAddition, symmetricKeyLifetime, customPasswordAddition, and unknownFutureValue. Each value of restrictionType can be used only once per policy. - `state`**Type**: `STRING`**Provider name**: `state` - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Description for this policy. Required. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Display name for this policy. Required. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `app_roles`{% #app_roles %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `appRoles`**Description**: The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. - `allowed_member_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `allowedMemberTypes`**Description**: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. - `description`**Type**: `STRING`**Provider name**: `description`**Description**: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Display name for the permission that appears in the app role assignment and consent experiences. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided. - `is_enabled`**Type**: `BOOLEAN`**Provider name**: `isEnabled`**Description**: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. - `origin`**Type**: `STRING`**Provider name**: `origin`**Description**: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren't allowed. May not begin with .. ## `application_template_id`{% #application_template_id %} **Type**: `STRING`**Provider name**: `applicationTemplateId`**Description**: Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the app wasn't created from an application template. ## `authentication_behaviors`{% #authentication_behaviors %} **Type**: `STRUCT`**Provider name**: `authenticationBehaviors` - `block_azure_ad_graph_access`**Type**: `BOOLEAN`**Provider name**: `blockAzureADGraphAccess` - `remove_unverified_email_claim`**Type**: `BOOLEAN`**Provider name**: `removeUnverifiedEmailClaim` - `require_client_service_principal`**Type**: `BOOLEAN`**Provider name**: `requireClientServicePrincipal` ## `certification`{% #certification %} **Type**: `STRUCT`**Provider name**: `certification`**Description**: Specifies the certification status of the application. - `certification_details_url`**Type**: `STRING`**Provider name**: `certificationDetailsUrl`**Description**: URL that shows certification details for the application. - `certification_expiration_date_time`**Type**: `STRING`**Provider name**: `certificationExpirationDateTime`**Description**: The timestamp when the current certification for the application expires. - `is_certified_by_microsoft`**Type**: `BOOLEAN`**Provider name**: `isCertifiedByMicrosoft`**Description**: Indicates whether the application is certified by Microsoft. - `is_publisher_attested`**Type**: `BOOLEAN`**Provider name**: `isPublisherAttested`**Description**: Indicates whether the application developer or publisher completed Publisher Attestation. - `last_certification_date_time`**Type**: `STRING`**Provider name**: `lastCertificationDateTime`**Description**: The timestamp when the certification for the application was most recently added or updated. ## `created_date_time`{% #created_date_time %} **Type**: `STRING`**Provider name**: `createdDateTime`**Description**: The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderby. ## `created_on_behalf_of`{% #created_on_behalf_of %} **Type**: `STRUCT`**Provider name**: `createdOnBehalfOf`**Description**: Supports $filter (/$count eq 0, /$count ne 0). Read-only. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `default_redirect_uri`{% #default_redirect_uri %} **Type**: `STRING`**Provider name**: `defaultRedirectUri` ## `deleted_date_time`{% #deleted_date_time %} **Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. ## `description`{% #description %} **Type**: `STRING`**Provider name**: `description`**Description**: Free text field to provide a description of the application object to end users. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. ## `disabled_by_microsoft_status`{% #disabled_by_microsoft_status %} **Type**: `STRING`**Provider name**: `disabledByMicrosoftStatus`**Description**: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not). ## `display_name`{% #display_name %} **Type**: `STRING`**Provider name**: `displayName`**Description**: The display name for the application. Maximum length is 256 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. ## `extension_properties`{% #extension_properties %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `extensionProperties`**Description**: Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0). - `app_display_name`**Type**: `STRING`**Provider name**: `appDisplayName`**Description**: Display name of the application object on which this extension property is defined. Read-only. - `data_type`**Type**: `STRING`**Provider name**: `dataType`**Description**: Specifies the data type of the value the extension property can hold. Following values are supported. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximumNot nullable. For multivalued directory extensions, these limits apply per value in the collection. - `is_multi_valued`**Type**: `BOOLEAN`**Provider name**: `isMultiValued`**Description**: Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as 'extensionb7b1c57b532f40b8b5ed4b7a7ba67401jobGroupTracker': ['String 1', 'String 2']. The default value is false. Supports $filter (eq). - `is_synced_from_on_premises`**Type**: `BOOLEAN`**Provider name**: `isSyncedFromOnPremises`**Description**: Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only. - `name`**Type**: `STRING`**Provider name**: `name` - `target_objects`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `targetObjects`**Description**: Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `federated_identity_credentials`{% #federated_identity_credentials %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `federatedIdentityCredentials`**Description**: Federated identities for applications. Supports $expand and $filter (startsWith, /$count eq 0, /$count ne 0). - `audiences`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `audiences`**Description**: The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you might need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required. - `description`**Type**: `STRING`**Provider name**: `description`**Description**: The unvalidated description of the federated identity credential, provided by the user. It has a limit of 600 characters. Optional. - `issuer`**Type**: `STRING`**Provider name**: `issuer`**Description**: The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique within the app. It has a limit of 600 characters. Required. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. The string is immutable after it's created. Alternate key. Required. Not nullable. Supports $filter (eq). - `subject`**Type**: `STRING`**Provider name**: `subject`**Description**: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format; each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. The combination of issuer and subject must be unique within the app. It has a limit of 600 characters. Supports $filter (eq). - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `group_membership_claims`{% #group_membership_claims %} **Type**: `STRING`**Provider name**: `groupMembershipClaims`**Description**: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Microsoft Entra roles), All (this gets all of the security groups, distribution groups, and Microsoft Entra directory roles that the signed-in user is a member of). ## `home_realm_discovery_policies`{% #home_realm_discovery_policies %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `homeRealmDiscoveryPolicies` - `name`**Type**: `STRING`**Provider name**: `name` - `applies_to`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `appliesTo` - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `definition`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `definition`**Description**: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. - `is_organization_default`**Type**: `BOOLEAN`**Provider name**: `isOrganizationDefault`**Description**: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Description for this policy. Required. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Display name for this policy. Required. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `id`{% #id %} **Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `identifier_uris`{% #identifier_uris %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `identifierUris`**Description**: Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API's code, and it must be globally unique across Microsoft Entra ID. For more information on valid identifierUris patterns and best practices, see Microsoft Entra application registration security best practices. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). ## `info`{% #info %} **Type**: `STRUCT`**Provider name**: `info`**Description**: Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Microsoft Entra apps. Supports $filter (eq, ne, not, ge, le, and eq on null values). - `logo_url`**Type**: `STRING`**Provider name**: `logoUrl`**Description**: CDN URL to the application's logo, Read-only. - `marketing_url`**Type**: `STRING`**Provider name**: `marketingUrl`**Description**: Link to the application's marketing page. For example, [https://www.contoso.com/app/marketing](https://www.contoso.com/app/marketing) - `privacy_statement_url`**Type**: `STRING`**Provider name**: `privacyStatementUrl`**Description**: Link to the application's privacy statement. For example, [https://www.contoso.com/app/privacy](https://www.contoso.com/app/privacy) - `support_url`**Type**: `STRING`**Provider name**: `supportUrl`**Description**: Link to the application's support page. For example, [https://www.contoso.com/app/support](https://www.contoso.com/app/support) - `terms_of_service_url`**Type**: `STRING`**Provider name**: `termsOfServiceUrl`**Description**: Link to the application's terms of service statement. For example, [https://www.contoso.com/app/termsofservice](https://www.contoso.com/app/termsofservice) ## `is_device_only_auth_supported`{% #is_device_only_auth_supported %} **Type**: `BOOLEAN`**Provider name**: `isDeviceOnlyAuthSupported`**Description**: Specifies whether this application supports device authentication without a user. The default is false. ## `is_fallback_public_client`{% #is_fallback_public_client %} **Type**: `BOOLEAN`**Provider name**: `isFallbackPublicClient`**Description**: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false, which means the fallback application type is confidential client such as a web app. There are certain scenarios where Microsoft Entra ID can't determine the client application type. For example, the ROPC flow where it's configured without specifying a redirect URI. In those cases, Microsoft Entra ID interprets the application type based on the value of this property. ## `key_credentials`{% #key_credentials %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `keyCredentials`**Description**: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le). - `custom_key_identifier`**Type**: `STRING`**Provider name**: `customKeyIdentifier`**Description**: A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: The friendly name for the key, with a maximum length of 90 characters. Longer values are accepted but shortened. Optional. - `end_date_time`**Type**: `STRING`**Provider name**: `endDateTime`**Description**: The date and time at which the credential expires. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: The certificate's raw data in byte array converted to Base64 string. Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it's always null. From a .cer certificate, you can read the key using the Convert.ToBase64String() method. For more information, see Get the certificate key. - `key_id`**Type**: `STRING`**Provider name**: `keyId`**Description**: The unique identifier (GUID) for the key. - `start_date_time`**Type**: `STRING`**Provider name**: `startDateTime`**Description**: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of key credential; for example, Symmetric, AsymmetricX509Cert. - `usage`**Type**: `STRING`**Provider name**: `usage`**Description**: A string that describes the purpose for which the key can be used; for example, Verify. ## `location`{% #location %} **Type**: `STRING` ## `logo`{% #logo %} **Type**: `STRING`**Provider name**: `logo`**Description**: The main logo for the application. Not nullable. ## `name`{% #name %} **Type**: `STRING`**Provider name**: `name` ## `native_authentication_apis_enabled`{% #native_authentication_apis_enabled %} **Type**: `STRING`**Provider name**: `nativeAuthenticationApisEnabled`**Description**: Specifies whether the Native Authentication APIs are enabled for the application. The possible values are: none and all. Default is none. For more information, see Native Authentication. ## `notes`{% #notes %} **Type**: `STRING`**Provider name**: `notes`**Description**: Notes relevant for the management of the application. ## `oauth2_required_post_response`{% #oauth2_required_post_response %} **Type**: `BOOLEAN`**Provider name**: `oauth2RequirePostResponse` ## `optional_claims`{% #optional_claims %} **Type**: `STRUCT`**Provider name**: `optionalClaims`**Description**: Application developers can configure optional claims in their Microsoft Entra applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app. - `access_token`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `accessToken`**Description**: The optional claims returned in the JWT access token. - `additional_properties`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `additionalProperties`**Description**: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. - `essential`**Type**: `BOOLEAN`**Provider name**: `essential`**Description**: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name of the optional claim. - `source`**Type**: `STRING`**Provider name**: `source`**Description**: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. - `id_token`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `idToken`**Description**: The optional claims returned in the JWT ID token. - `additional_properties`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `additionalProperties`**Description**: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. - `essential`**Type**: `BOOLEAN`**Provider name**: `essential`**Description**: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name of the optional claim. - `source`**Type**: `STRING`**Provider name**: `source`**Description**: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. - `saml2_token`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `saml2Token`**Description**: The optional claims returned in the SAML token. - `additional_properties`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `additionalProperties`**Description**: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. - `essential`**Type**: `BOOLEAN`**Provider name**: `essential`**Description**: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name of the optional claim. - `source`**Type**: `STRING`**Provider name**: `source`**Description**: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. ## `owners`{% #owners %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `owners`**Description**: Directory objects that are owners of this application. The owners are a set of nonadmin users or service principals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `parental_control_settings`{% #parental_control_settings %} **Type**: `STRUCT`**Provider name**: `parentalControlSettings`**Description**: Specifies parental control settings for an application. - `legal_age_group_rule`**Type**: `STRING`**Provider name**: `legalAgeGroupRule`**Description**: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country/region minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country/region minor rules.BlockMinorsBlocks minors from using the app. ## `password_credentials`{% #password_credentials %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `passwordCredentials`**Description**: The collection of password credentials associated with the application. Not nullable. - `custom_key_identifier`**Type**: `STRING`**Provider name**: `customKeyIdentifier`**Description**: Do not use. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Friendly name for the password. Optional. - `end_date_time`**Type**: `STRING`**Provider name**: `endDateTime`**Description**: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. - `hint`**Type**: `STRING`**Provider name**: `hint`**Description**: Contains the first three characters of the password. Read-only. - `key_id`**Type**: `STRING`**Provider name**: `keyId`**Description**: The unique identifier for the password. - `secret_text`**Type**: `STRING`**Provider name**: `secretText`**Description**: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future. - `start_date_time`**Type**: `STRING`**Provider name**: `startDateTime`**Description**: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. ## `public_client`{% #public_client %} **Type**: `STRUCT`**Provider name**: `publicClient`**Description**: Specifies settings for installed clients such as desktop or mobile devices. - `redirect_uris`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `redirectUris`**Description**: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. For iOS and macOS apps, specify the value following the syntax msauth.{BUNDLEID}://auth, replacing '{BUNDLEID}'. For example, if the bundle ID is com.microsoft.identitysample.MSALiOS, the URI is msauth.com.microsoft.identitysample.MSALiOS://auth. ## `publisher_domain`{% #publisher_domain %} **Type**: `STRING`**Provider name**: `publisherDomain`**Description**: The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application's publisher domain. Supports $filter (eq, ne, ge, le, startsWith). ## `request_signature_verification`{% #request_signature_verification %} **Type**: `STRUCT`**Provider name**: `requestSignatureVerification`**Description**: Specifies whether this application requires Microsoft Entra ID to verify the signed authentication requests. - `allowed_weak_algorithms`**Type**: `STRING`**Provider name**: `allowedWeakAlgorithms`**Description**: Specifies which weak algorithms are allowed. The possible values are: rsaSha1, unknownFutureValue. - `is_signed_request_required`**Type**: `BOOLEAN`**Provider name**: `isSignedRequestRequired`**Description**: Specifies whether signed authentication requests for this application should be required. ## `required_resource_access`{% #required_resource_access %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `requiredResourceAccess`**Description**: Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable. Supports $filter (eq, not, ge, le). - `resource_access`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `resourceAccess`**Description**: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier of an app role or delegated permission exposed by the resource application. For delegated permissions, this should match the id property of one of the delegated permissions in the oauth2PermissionScopes collection of the resource application's service principal. For app roles (application permissions), this should match the id property of an app role in the appRoles collection of the resource application's service principal. - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Specifies whether the id property references a delegated permission or an app role (application permission). The possible values are: Scope (for delegated permissions) or Role (for app roles). - `resource_app_id`**Type**: `STRING`**Provider name**: `resourceAppId`**Description**: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. ## `resource_group`{% #resource_group %} **Type**: `STRING` ## `saml_metadata_url`{% #saml_metadata_url %} **Type**: `STRING`**Provider name**: `samlMetadataUrl`**Description**: The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. ## `service_management_reference`{% #service_management_reference %} **Type**: `STRING`**Provider name**: `serviceManagementReference`**Description**: References application or service contact information from a Service or Asset Management database. Nullable. ## `service_principal_lock_configuration`{% #service_principal_lock_configuration %} **Type**: `STRUCT`**Provider name**: `servicePrincipalLockConfiguration`**Description**: Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. null by default. - `all_properties`**Type**: `BOOLEAN`**Provider name**: `allProperties`**Description**: Enables locking all sensitive properties. The sensitive properties are keyCredentials, passwordCredentials, and tokenEncryptionKeyId. - `credentials_with_usage_sign`**Type**: `BOOLEAN`**Provider name**: `credentialsWithUsageSign`**Description**: Locks the keyCredentials and passwordCredentials properties for modification where credential usage type is Sign. - `credentials_with_usage_verify`**Type**: `BOOLEAN`**Provider name**: `credentialsWithUsageVerify`**Description**: Locks the keyCredentials and passwordCredentials properties for modification where credential usage type is Verify. This locks OAuth service principals. - `is_enabled`**Type**: `BOOLEAN`**Provider name**: `isEnabled`**Description**: Enables or disables service principal lock configuration. To allow the sensitive properties to be updated, update this property to false to disable the lock on the service principal. - `token_encryption_key_id`**Type**: `BOOLEAN`**Provider name**: `tokenEncryptionKeyId`**Description**: Locks the tokenEncryptionKeyId property for modification on the service principal. ## `sign_in_audience`{% #sign_in_audience %} **Type**: `STRING`**Provider name**: `signInAudience`**Description**: Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg (default), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, and PersonalMicrosoftAccount. See more in the table. The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app. The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see Validation differences for signInAudience.Supports $filter (eq, ne, not). ## `spa`{% #spa %} **Type**: `STRUCT`**Provider name**: `spa`**Description**: Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. - `redirect_uris`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `redirectUris`**Description**: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. ## `subscription_id`{% #subscription_id %} **Type**: `STRING` ## `subscription_name`{% #subscription_name %} **Type**: `STRING` ## `synchronization`{% #synchronization %} **Type**: `STRUCT`**Provider name**: `synchronization`**Description**: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. - `jobs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `jobs`**Description**: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory. - `bulk_upload`**Type**: `STRUCT`**Provider name**: `bulkUpload`**Description**: The bulk upload operation for the job. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `name`**Type**: `STRING`**Provider name**: `name` - `schedule`**Type**: `STRUCT`**Provider name**: `schedule`**Description**: Schedule used to run the job. Read-only. - `expiration`**Type**: `STRING`**Provider name**: `expiration`**Description**: Date and time when this job expires. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `interval`**Type**: `STRING`**Provider name**: `interval`**Description**: The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, P1M represents a period of one month and PT1M represents a period of one minute. - `state`**Type**: `STRING`**Provider name**: `state` - `schema`**Type**: `STRUCT`**Provider name**: `schema`**Description**: The synchronization schema configured for the job. - `directories`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `directories`**Description**: Contains the collection of directories and all of their objects. - `discoverabilities`**Type**: `STRING`**Provider name**: `discoverabilities` - `discovery_date_time`**Type**: `STRING`**Provider name**: `discoveryDateTime`**Description**: Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the directory. Must be unique within the synchronization schema. Not nullable. - `objects`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `objects`**Description**: Collection of objects supported by the directory. - `attributes`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `attributes`**Description**: Defines attributes of the object. - `anchor`**Type**: `BOOLEAN`**Provider name**: `anchor`**Description**: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization. - `api_expressions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `apiExpressions` - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Key. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value. - `case_exact`**Type**: `BOOLEAN`**Provider name**: `caseExact`**Description**: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute. - `default_value`**Type**: `STRING`**Provider name**: `defaultValue`**Description**: The default value of the attribute. - `flow_null_values`**Type**: `BOOLEAN`**Provider name**: `flowNullValues`**Description**: 'true' to allow null values for attributes. - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Metadata for the given object. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: BaseAttributeName, ComplexObjectDefinition, IsContainer, IsCustomerDefined, IsDomainQualified, LinkPropertyNames, LinkTypeName, MaximumLength, ReferencedProperty. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `multivalued`**Type**: `BOOLEAN`**Provider name**: `multivalued`**Description**: true if an attribute can have multiple values. Default is false. - `mutability`**Type**: `STRING`**Provider name**: `mutability` - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the attribute. Must be unique within the object definition. Not nullable. - `referenced_objects`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `referencedObjects`**Description**: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object). - `referenced_object_name`**Type**: `STRING`**Provider name**: `referencedObjectName`**Description**: Name of the referenced object. Must match one of the objects in the directory definition. - `referenced_property`**Type**: `STRING`**Provider name**: `referencedProperty`**Description**: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference. - `required`**Type**: `BOOLEAN`**Provider name**: `required`**Description**: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error. - `type`**Type**: `STRING`**Provider name**: `type` - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Metadata for the given object. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: PropertyNameAccountEnabled, PropertyNameSoftDeleted, IsSoftDeletionSupported, IsSynchronizeAllSupported, ConnectorDataStorageRequired, Extensions, LinkTypeName. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the object. Must be unique within a directory definition. Not nullable. - `supported_apis`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `supportedApis`**Description**: The API that the provisioning service queries to retrieve data for synchronization. - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: Whether this object is read-only. - `version`**Type**: `STRING`**Provider name**: `version`**Description**: Read only value that indicates version discovered. null if discovery hasn't yet occurred. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `name`**Type**: `STRING`**Provider name**: `name` - `synchronization_rules`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `synchronizationRules`**Description**: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate. - `container_filter`**Type**: `STRUCT`**Provider name**: `containerFilter` - `included_containers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `includedContainers` - `editable`**Type**: `BOOLEAN`**Provider name**: `editable`**Description**: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed. - `group_filter`**Type**: `STRUCT`**Provider name**: `groupFilter` - `included_groups`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `includedGroups` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API. - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn't be changed. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Key. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the synchronization rule. Not nullable. - `object_mappings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `objectMappings`**Description**: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized. - `attribute_mappings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `attributeMappings`**Description**: Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values. - `default_value`**Type**: `STRING`**Provider name**: `defaultValue`**Description**: Default value to be used in case the source property was evaluated to null. Optional. - `export_missing_references`**Type**: `BOOLEAN`**Provider name**: `exportMissingReferences`**Description**: For internal use only. - `flow_behavior`**Type**: `STRING`**Provider name**: `flowBehavior` - `flow_type`**Type**: `STRING`**Provider name**: `flowType` - `matching_priority`**Type**: `INT32`**Provider name**: `matchingPriority`**Description**: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories. The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first. If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left. Only attributes that are expected to have unique values, such as email, should be used as matching attributes. - `source`**Type**: `STRUCT`**Provider name**: `source`**Description**: Defines how a value should be extracted (or transformed) from the source object. - `expression`**Type**: `STRING`**Provider name**: `expression`**Description**: Equivalent expression representation of this attributeMappingSource object. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used. - `parameters`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `parameters`**Description**: If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn't Function, this property is null/empty array. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: The name of the parameter. - `value`**Type**: `STRUCT`**Provider name**: `value`**Description**: The value of the parameter. - `type`**Type**: `STRING`**Provider name**: `type` - `target_attribute_name`**Type**: `STRING`**Provider name**: `targetAttributeName`**Description**: Name of the attribute on the target object. - `enabled`**Type**: `BOOLEAN`**Provider name**: `enabled`**Description**: When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped. - `flow_types`**Type**: `STRING`**Provider name**: `flowTypes` - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: EscrowBehavior, DisableMonitoringForChanges, OriginalJoiningProperty, Disposition, IsCustomerDefined, ExcludeFromReporting, Unsynchronized. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-friendly name of the object mapping. - `scope`**Type**: `STRUCT`**Provider name**: `scope`**Description**: Defines a filter to be used when deciding whether a given object should be provisioned. For example, you might want to only provision users that are located in the US. - `category_filter_groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `categoryFilterGroups`**Description**: *Experimental* Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true. - `clauses`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `clauses`**Description**: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true. - `operator_name`**Type**: `STRING`**Provider name**: `operatorName`**Description**: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered. - `source_operand_name`**Type**: `STRING`**Provider name**: `sourceOperandName`**Description**: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object. - `target_operand`**Type**: `STRUCT`**Provider name**: `targetOperand`**Description**: Values that the source operand will be tested against. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the filter group. - `groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `groups`**Description**: Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get deprovisioned'. An object is considered in scope if ANY of the groups in the collection is evaluated to true. - `clauses`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `clauses`**Description**: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true. - `operator_name`**Type**: `STRING`**Provider name**: `operatorName`**Description**: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered. - `source_operand_name`**Type**: `STRING`**Provider name**: `sourceOperandName`**Description**: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object. - `target_operand`**Type**: `STRUCT`**Provider name**: `targetOperand`**Description**: Values that the source operand will be tested against. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the filter group. - `input_filter_groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `inputFilterGroups`**Description**: *Experimental* Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, then it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get deprovisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true. - `clauses`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `clauses`**Description**: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true. - `operator_name`**Type**: `STRING`**Provider name**: `operatorName`**Description**: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered. - `source_operand_name`**Type**: `STRING`**Provider name**: `sourceOperandName`**Description**: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object. - `target_operand`**Type**: `STRUCT`**Provider name**: `targetOperand`**Description**: Values that the source operand will be tested against. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the filter group. - `source_object_name`**Type**: `STRING`**Provider name**: `sourceObjectName`**Description**: Name of the object in the source directory. Must match the object name from the source directory definition. - `target_object_name`**Type**: `STRING`**Provider name**: `targetObjectName`**Description**: Name of the object in target directory. Must match the object name from the target directory definition. - `priority`**Type**: `INT32`**Provider name**: `priority`**Description**: Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first. - `source_directory_name`**Type**: `STRING`**Provider name**: `sourceDirectoryName`**Description**: Name of the source directory. Must match one of the directory definitions in synchronizationSchema. - `target_directory_name`**Type**: `STRING`**Provider name**: `targetDirectoryName`**Description**: Name of the target directory. Must match one of the directory definitions in synchronizationSchema. - `version`**Type**: `STRING`**Provider name**: `version`**Description**: The version of the schema, updated automatically with every schema change. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `status`**Type**: `STRUCT`**Provider name**: `status`**Description**: Status of the job, which includes when the job was last run, current job state, and errors. - `code`**Type**: `STRING`**Provider name**: `code` - `count_successive_complete_failures`**Type**: `INT64`**Provider name**: `countSuccessiveCompleteFailures`**Description**: Number of consecutive times this job failed. - `escrows_pruned`**Type**: `BOOLEAN`**Provider name**: `escrowsPruned`**Description**: true if the job's escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job's errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors. - `last_execution`**Type**: `STRUCT`**Provider name**: `lastExecution`**Description**: Details of the last execution of the job. - `activity_identifier`**Type**: `STRING`**Provider name**: `activityIdentifier`**Description**: Identifier of the job run. - `count_entitled`**Type**: `INT64`**Provider name**: `countEntitled`**Description**: Count of processed entries that were assigned for this application. - `count_entitled_for_provisioning`**Type**: `INT64`**Provider name**: `countEntitledForProvisioning`**Description**: Count of processed entries that were assigned for provisioning. - `count_escrowed`**Type**: `INT64`**Provider name**: `countEscrowed`**Description**: Count of entries that were escrowed (errors). - `count_escrowed_raw`**Type**: `INT64`**Provider name**: `countEscrowedRaw`**Description**: Count of entries that were escrowed, including system-generated escrows. - `count_exported`**Type**: `INT64`**Provider name**: `countExported`**Description**: Count of exported entries. - `count_exports`**Type**: `INT64`**Provider name**: `countExports`**Description**: Count of entries that were expected to be exported. - `count_imported`**Type**: `INT64`**Provider name**: `countImported`**Description**: Count of imported entries. - `count_imported_deltas`**Type**: `INT64`**Provider name**: `countImportedDeltas`**Description**: Count of imported delta-changes. - `count_imported_reference_deltas`**Type**: `INT64`**Provider name**: `countImportedReferenceDeltas`**Description**: Count of imported delta-changes pertaining to reference changes. - `error`**Type**: `STRUCT`**Provider name**: `error`**Description**: If an error was encountered, contains a synchronizationError object with details. - `code`**Type**: `STRING`**Provider name**: `code`**Description**: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure. - `message`**Type**: `STRING`**Provider name**: `message`**Description**: The error message. For example, Policy permitting auto-redemption of invitations not configured. - `tenant_actionable`**Type**: `BOOLEAN`**Provider name**: `tenantActionable`**Description**: The action to take to resolve the error. For example, false. - `state`**Type**: `STRING`**Provider name**: `state` - `time_began`**Type**: `STRING`**Provider name**: `timeBegan`**Description**: Time when this job run began. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `time_ended`**Type**: `STRING`**Provider name**: `timeEnded`**Description**: Time when this job run ended. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `last_successful_execution`**Type**: `STRUCT`**Provider name**: `lastSuccessfulExecution`**Description**: Details of the last execution of this job, which didn't have any errors. - `activity_identifier`**Type**: `STRING`**Provider name**: `activityIdentifier`**Description**: Identifier of the job run. - `count_entitled`**Type**: `INT64`**Provider name**: `countEntitled`**Description**: Count of processed entries that were assigned for this application. - `count_entitled_for_provisioning`**Type**: `INT64`**Provider name**: `countEntitledForProvisioning`**Description**: Count of processed entries that were assigned for provisioning. - `count_escrowed`**Type**: `INT64`**Provider name**: `countEscrowed`**Description**: Count of entries that were escrowed (errors). - `count_escrowed_raw`**Type**: `INT64`**Provider name**: `countEscrowedRaw`**Description**: Count of entries that were escrowed, including system-generated escrows. - `count_exported`**Type**: `INT64`**Provider name**: `countExported`**Description**: Count of exported entries. - `count_exports`**Type**: `INT64`**Provider name**: `countExports`**Description**: Count of entries that were expected to be exported. - `count_imported`**Type**: `INT64`**Provider name**: `countImported`**Description**: Count of imported entries. - `count_imported_deltas`**Type**: `INT64`**Provider name**: `countImportedDeltas`**Description**: Count of imported delta-changes. - `count_imported_reference_deltas`**Type**: `INT64`**Provider name**: `countImportedReferenceDeltas`**Description**: Count of imported delta-changes pertaining to reference changes. - `error`**Type**: `STRUCT`**Provider name**: `error`**Description**: If an error was encountered, contains a synchronizationError object with details. - `code`**Type**: `STRING`**Provider name**: `code`**Description**: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure. - `message`**Type**: `STRING`**Provider name**: `message`**Description**: The error message. For example, Policy permitting auto-redemption of invitations not configured. - `tenant_actionable`**Type**: `BOOLEAN`**Provider name**: `tenantActionable`**Description**: The action to take to resolve the error. For example, false. - `state`**Type**: `STRING`**Provider name**: `state` - `time_began`**Type**: `STRING`**Provider name**: `timeBegan`**Description**: Time when this job run began. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `time_ended`**Type**: `STRING`**Provider name**: `timeEnded`**Description**: Time when this job run ended. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `last_successful_execution_with_exports`**Type**: `STRUCT`**Provider name**: `lastSuccessfulExecutionWithExports`**Description**: Details of the last execution of the job, which exported objects into the target directory. - `activity_identifier`**Type**: `STRING`**Provider name**: `activityIdentifier`**Description**: Identifier of the job run. - `count_entitled`**Type**: `INT64`**Provider name**: `countEntitled`**Description**: Count of processed entries that were assigned for this application. - `count_entitled_for_provisioning`**Type**: `INT64`**Provider name**: `countEntitledForProvisioning`**Description**: Count of processed entries that were assigned for provisioning. - `count_escrowed`**Type**: `INT64`**Provider name**: `countEscrowed`**Description**: Count of entries that were escrowed (errors). - `count_escrowed_raw`**Type**: `INT64`**Provider name**: `countEscrowedRaw`**Description**: Count of entries that were escrowed, including system-generated escrows. - `count_exported`**Type**: `INT64`**Provider name**: `countExported`**Description**: Count of exported entries. - `count_exports`**Type**: `INT64`**Provider name**: `countExports`**Description**: Count of entries that were expected to be exported. - `count_imported`**Type**: `INT64`**Provider name**: `countImported`**Description**: Count of imported entries. - `count_imported_deltas`**Type**: `INT64`**Provider name**: `countImportedDeltas`**Description**: Count of imported delta-changes. - `count_imported_reference_deltas`**Type**: `INT64`**Provider name**: `countImportedReferenceDeltas`**Description**: Count of imported delta-changes pertaining to reference changes. - `error`**Type**: `STRUCT`**Provider name**: `error`**Description**: If an error was encountered, contains a synchronizationError object with details. - `code`**Type**: `STRING`**Provider name**: `code`**Description**: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure. - `message`**Type**: `STRING`**Provider name**: `message`**Description**: The error message. For example, Policy permitting auto-redemption of invitations not configured. - `tenant_actionable`**Type**: `BOOLEAN`**Provider name**: `tenantActionable`**Description**: The action to take to resolve the error. For example, false. - `state`**Type**: `STRING`**Provider name**: `state` - `time_began`**Type**: `STRING`**Provider name**: `timeBegan`**Description**: Time when this job run began. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `time_ended`**Type**: `STRING`**Provider name**: `timeEnded`**Description**: Time when this job run ended. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `progress`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `progress`**Description**: Details of the progress of a job toward completion. - `completed_units`**Type**: `INT64`**Provider name**: `completedUnits`**Description**: The numerator of a progress ratio; the number of units of changes already processed. - `progress_observation_date_time`**Type**: `STRING`**Provider name**: `progressObservationDateTime`**Description**: The time of a progress observation as an offset in minutes from UTC. - `total_units`**Type**: `INT64`**Provider name**: `totalUnits`**Description**: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization. - `units`**Type**: `STRING`**Provider name**: `units`**Description**: An optional description of the units. - `quarantine`**Type**: `STRUCT`**Provider name**: `quarantine`**Description**: If job is in quarantine, quarantine details. - `current_began`**Type**: `STRING`**Provider name**: `currentBegan`**Description**: Date and time when the quarantine was last evaluated and imposed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `error`**Type**: `STRUCT`**Provider name**: `error`**Description**: Describes the error(s) that occurred when putting the synchronization job into quarantine. - `code`**Type**: `STRING`**Provider name**: `code`**Description**: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure. - `message`**Type**: `STRING`**Provider name**: `message`**Description**: The error message. For example, Policy permitting auto-redemption of invitations not configured. - `tenant_actionable`**Type**: `BOOLEAN`**Provider name**: `tenantActionable`**Description**: The action to take to resolve the error. For example, false. - `next_attempt`**Type**: `STRING`**Provider name**: `nextAttempt`**Description**: Date and time when the next attempt to re-evaluate the quarantine will be made. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `reason`**Type**: `STRING`**Provider name**: `reason` - `series_began`**Type**: `STRING`**Provider name**: `seriesBegan`**Description**: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted). The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `series_count`**Type**: `INT64`**Provider name**: `seriesCount`**Description**: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted). - `steady_state_first_achieved_time`**Type**: `STRING`**Provider name**: `steadyStateFirstAchievedTime`**Description**: The time when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `steady_state_last_achieved_time`**Type**: `STRING`**Provider name**: `steadyStateLastAchievedTime`**Description**: The time when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `synchronized_entry_count_by_type`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `synchronizedEntryCountByType`**Description**: Count of synchronized objects, listed by object type. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: The mapping of the user type from the source system to the target system. For example:User to User - For Microsoft Entra ID to Microsoft Entra ID synchronization worker to user - For Workday to Microsoft Entra synchronization. - `value`**Type**: `INT64`**Provider name**: `value`**Description**: Total number of synchronized objects. - `troubleshooting_url`**Type**: `STRING`**Provider name**: `troubleshootingUrl`**Description**: In the event of an error, the URL with the troubleshooting steps for the issue. - `synchronization_job_settings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `synchronizationJobSettings`**Description**: Settings associated with the job. Some settings are inherited from the template. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name for this key-value pair - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value for this key-value pair - `template_id`**Type**: `STRING`**Provider name**: `templateId`**Description**: Identifier of the synchronization template this job is based on. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `name`**Type**: `STRING`**Provider name**: `name` - `secrets`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `secrets`**Description**: Represents a collection of credentials to access provisioned cloud applications. - `key`**Type**: `STRING`**Provider name**: `key` - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value of the secret. - `templates`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `templates`**Description**: Preconfigured synchronization settings for a particular application. - `application_id`**Type**: `STRING`**Provider name**: `applicationId`**Description**: Identifier of the application this template belongs to. - `default`**Type**: `BOOLEAN`**Provider name**: `default`**Description**: true if this template is recommended to be the default for the application. - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Description of the template. - `discoverable`**Type**: `BOOLEAN`**Provider name**: `discoverable`**Description**: true if this template should appear in the collection of templates available for the application instance (service principal). - `factory_tag`**Type**: `STRING`**Provider name**: `factoryTag`**Description**: One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template. - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: GalleryApplicationIdentifier, GalleryApplicationKey, IsOAuthEnabled, IsSynchronizationAgentAssignmentRequired, IsSynchronizationAgentRequired, IsSynchronizationInPreview, OAuthSettings, SynchronizationLearnMoreIbizaFwLink, ConfigurationFields. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `name`**Type**: `STRING`**Provider name**: `name` - `schema`**Type**: `STRUCT`**Provider name**: `schema`**Description**: Default synchronization schema for the jobs based on this template. - `directories`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `directories`**Description**: Contains the collection of directories and all of their objects. - `discoverabilities`**Type**: `STRING`**Provider name**: `discoverabilities` - `discovery_date_time`**Type**: `STRING`**Provider name**: `discoveryDateTime`**Description**: Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the directory. Must be unique within the synchronization schema. Not nullable. - `objects`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `objects`**Description**: Collection of objects supported by the directory. - `attributes`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `attributes`**Description**: Defines attributes of the object. - `anchor`**Type**: `BOOLEAN`**Provider name**: `anchor`**Description**: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization. - `api_expressions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `apiExpressions` - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Key. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value. - `case_exact`**Type**: `BOOLEAN`**Provider name**: `caseExact`**Description**: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute. - `default_value`**Type**: `STRING`**Provider name**: `defaultValue`**Description**: The default value of the attribute. - `flow_null_values`**Type**: `BOOLEAN`**Provider name**: `flowNullValues`**Description**: 'true' to allow null values for attributes. - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Metadata for the given object. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: BaseAttributeName, ComplexObjectDefinition, IsContainer, IsCustomerDefined, IsDomainQualified, LinkPropertyNames, LinkTypeName, MaximumLength, ReferencedProperty. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `multivalued`**Type**: `BOOLEAN`**Provider name**: `multivalued`**Description**: true if an attribute can have multiple values. Default is false. - `mutability`**Type**: `STRING`**Provider name**: `mutability` - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the attribute. Must be unique within the object definition. Not nullable. - `referenced_objects`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `referencedObjects`**Description**: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object). - `referenced_object_name`**Type**: `STRING`**Provider name**: `referencedObjectName`**Description**: Name of the referenced object. Must match one of the objects in the directory definition. - `referenced_property`**Type**: `STRING`**Provider name**: `referencedProperty`**Description**: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference. - `required`**Type**: `BOOLEAN`**Provider name**: `required`**Description**: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error. - `type`**Type**: `STRING`**Provider name**: `type` - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Metadata for the given object. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: PropertyNameAccountEnabled, PropertyNameSoftDeleted, IsSoftDeletionSupported, IsSynchronizeAllSupported, ConnectorDataStorageRequired, Extensions, LinkTypeName. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the object. Must be unique within a directory definition. Not nullable. - `supported_apis`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `supportedApis`**Description**: The API that the provisioning service queries to retrieve data for synchronization. - `read_only`**Type**: `BOOLEAN`**Provider name**: `readOnly`**Description**: Whether this object is read-only. - `version`**Type**: `STRING`**Provider name**: `version`**Description**: Read only value that indicates version discovered. null if discovery hasn't yet occurred. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `name`**Type**: `STRING`**Provider name**: `name` - `synchronization_rules`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `synchronizationRules`**Description**: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate. - `container_filter`**Type**: `STRUCT`**Provider name**: `containerFilter` - `included_containers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `includedContainers` - `editable`**Type**: `BOOLEAN`**Provider name**: `editable`**Description**: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed. - `group_filter`**Type**: `STRUCT`**Provider name**: `groupFilter` - `included_groups`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `includedGroups` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API. - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn't be changed. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Key. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the synchronization rule. Not nullable. - `object_mappings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `objectMappings`**Description**: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized. - `attribute_mappings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `attributeMappings`**Description**: Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values. - `default_value`**Type**: `STRING`**Provider name**: `defaultValue`**Description**: Default value to be used in case the source property was evaluated to null. Optional. - `export_missing_references`**Type**: `BOOLEAN`**Provider name**: `exportMissingReferences`**Description**: For internal use only. - `flow_behavior`**Type**: `STRING`**Provider name**: `flowBehavior` - `flow_type`**Type**: `STRING`**Provider name**: `flowType` - `matching_priority`**Type**: `INT32`**Provider name**: `matchingPriority`**Description**: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories. The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first. If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left. Only attributes that are expected to have unique values, such as email, should be used as matching attributes. - `source`**Type**: `STRUCT`**Provider name**: `source`**Description**: Defines how a value should be extracted (or transformed) from the source object. - `expression`**Type**: `STRING`**Provider name**: `expression`**Description**: Equivalent expression representation of this attributeMappingSource object. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used. - `parameters`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `parameters`**Description**: If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn't Function, this property is null/empty array. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: The name of the parameter. - `value`**Type**: `STRUCT`**Provider name**: `value`**Description**: The value of the parameter. - `type`**Type**: `STRING`**Provider name**: `type` - `target_attribute_name`**Type**: `STRING`**Provider name**: `targetAttributeName`**Description**: Name of the attribute on the target object. - `enabled`**Type**: `BOOLEAN`**Provider name**: `enabled`**Description**: When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped. - `flow_types`**Type**: `STRING`**Provider name**: `flowTypes` - `metadata`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `metadata`**Description**: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed. - `key`**Type**: `STRING`**Provider name**: `key`**Description**: Possible values are: EscrowBehavior, DisableMonitoringForChanges, OriginalJoiningProperty, Disposition, IsCustomerDefined, ExcludeFromReporting, Unsynchronized. - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Value of the metadata property. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-friendly name of the object mapping. - `scope`**Type**: `STRUCT`**Provider name**: `scope`**Description**: Defines a filter to be used when deciding whether a given object should be provisioned. For example, you might want to only provision users that are located in the US. - `category_filter_groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `categoryFilterGroups`**Description**: *Experimental* Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true. - `clauses`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `clauses`**Description**: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true. - `operator_name`**Type**: `STRING`**Provider name**: `operatorName`**Description**: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered. - `source_operand_name`**Type**: `STRING`**Provider name**: `sourceOperandName`**Description**: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object. - `target_operand`**Type**: `STRUCT`**Provider name**: `targetOperand`**Description**: Values that the source operand will be tested against. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the filter group. - `groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `groups`**Description**: Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get deprovisioned'. An object is considered in scope if ANY of the groups in the collection is evaluated to true. - `clauses`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `clauses`**Description**: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true. - `operator_name`**Type**: `STRING`**Provider name**: `operatorName`**Description**: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered. - `source_operand_name`**Type**: `STRING`**Provider name**: `sourceOperandName`**Description**: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object. - `target_operand`**Type**: `STRUCT`**Provider name**: `targetOperand`**Description**: Values that the source operand will be tested against. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the filter group. - `input_filter_groups`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `inputFilterGroups`**Description**: *Experimental* Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, then it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get deprovisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true. - `clauses`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `clauses`**Description**: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true. - `operator_name`**Type**: `STRING`**Provider name**: `operatorName`**Description**: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered. - `source_operand_name`**Type**: `STRING`**Provider name**: `sourceOperandName`**Description**: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object. - `target_operand`**Type**: `STRUCT`**Provider name**: `targetOperand`**Description**: Values that the source operand will be tested against. - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Human-readable name of the filter group. - `source_object_name`**Type**: `STRING`**Provider name**: `sourceObjectName`**Description**: Name of the object in the source directory. Must match the object name from the source directory definition. - `target_object_name`**Type**: `STRING`**Provider name**: `targetObjectName`**Description**: Name of the object in target directory. Must match the object name from the target directory definition. - `priority`**Type**: `INT32`**Provider name**: `priority`**Description**: Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first. - `source_directory_name`**Type**: `STRING`**Provider name**: `sourceDirectoryName`**Description**: Name of the source directory. Must match one of the directory definitions in synchronizationSchema. - `target_directory_name`**Type**: `STRING`**Provider name**: `targetDirectoryName`**Description**: Name of the target directory. Must match one of the directory definitions in synchronizationSchema. - `version`**Type**: `STRING`**Provider name**: `version`**Description**: The version of the schema, updated automatically with every schema change. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `token_encryption_key_id`{% #token_encryption_key_id %} **Type**: `STRING`**Provider name**: `tokenEncryptionKeyId`**Description**: Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. ## `token_issuance_policies`{% #token_issuance_policies %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `tokenIssuancePolicies` - `name`**Type**: `STRING`**Provider name**: `name` - `applies_to`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `appliesTo` - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `definition`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `definition`**Description**: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. - `is_organization_default`**Type**: `BOOLEAN`**Provider name**: `isOrganizationDefault`**Description**: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Description for this policy. Required. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Display name for this policy. Required. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `token_lifetime_policies`{% #token_lifetime_policies %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `tokenLifetimePolicies` - `name`**Type**: `STRING`**Provider name**: `name` - `applies_to`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `appliesTo` - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `name`**Type**: `STRING`**Provider name**: `name` - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. - `definition`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `definition`**Description**: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. - `is_organization_default`**Type**: `BOOLEAN`**Provider name**: `isOrganizationDefault`**Description**: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Description for this policy. Required. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: Display name for this policy. Required. - `deleted_date_time`**Type**: `STRING`**Provider name**: `deletedDateTime`**Description**: Date and time when this object was deleted. Always null when the object hasn't been deleted. - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The unique identifier for an entity. Read-only. ## `unique_name`{% #unique_name %} **Type**: `STRING`**Provider name**: `uniqueName`**Description**: The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only. ## `verified_publisher`{% #verified_publisher %} **Type**: `STRUCT`**Provider name**: `verifiedPublisher`**Description**: Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification. - `added_date_time`**Type**: `STRING`**Provider name**: `addedDateTime`**Description**: The timestamp when the verified publisher was first added or most recently updated. - `display_name`**Type**: `STRING`**Provider name**: `displayName`**Description**: The verified publisher name from the app publisher's Partner Center account. - `verified_publisher_id`**Type**: `STRING`**Provider name**: `verifiedPublisherId`**Description**: The ID of the verified publisher from the app publisher's Partner Center account. ## `web`{% #web %} **Type**: `STRUCT`**Provider name**: `web`**Description**: Specifies settings for a web application. - `home_page_url`**Type**: `STRING`**Provider name**: `homePageUrl`**Description**: Home page or landing page of the application. - `implicit_grant_settings`**Type**: `STRUCT`**Provider name**: `implicitGrantSettings`**Description**: Specifies whether this web application can request tokens using the OAuth 2.0 implicit flow. - `enable_access_token_issuance`**Type**: `BOOLEAN`**Provider name**: `enableAccessTokenIssuance`**Description**: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. - `enable_id_token_issuance`**Type**: `BOOLEAN`**Provider name**: `enableIdTokenIssuance`**Description**: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. - `logout_url`**Type**: `STRING`**Provider name**: `logoutUrl`**Description**: Specifies the URL that is used by Microsoft's authorization service to log out a user using front-channel, back-channel or SAML logout protocols. - `redirect_uri_settings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `redirectUriSettings` - `index`**Type**: `INT32`**Provider name**: `index` - `uri`**Type**: `STRING`**Provider name**: `uri` - `redirect_uris`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `redirectUris`**Description**: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.