How do I configure application and servicePrincipal resource types in the MS Graph API connector in Identity Cloud and IDM (All versions)?
The purpose of this article is to provide example configurations for the "application" and "servicePrincipal" resource types in the MS Graph API connector in ForgeRock Identity Cloud and IDM. This information only applies to the MS Graph API connector 1.5.20.13 and later.
Overview
This article provides example configurations for the application and servicePrincipal resource types in the MS Graph API connector. These configurations are needed if you want to manage applications and/or servicePrincipals in Microsoft® Azure® via Identity Cloud or IDM. These examples demonstrate the format required to get you started but you will need to adjust them to fit your requirements and environment.
You can configure the connector via REST or the provisioner file (IDM only). See Configure the MS Graph API connector for further information.
Application resource type
The following example configuration shows the format required for an application resource type:
"$schema": "http://json-schema.org/draft-03/schema", "id": "application", "type": "object", "nativeType": "application", "properties": { "applicationTemplateId": { "type": "string", "nativeName": "applicationTemplateId", "nativeType": "string" }, "description": { "type": "string", "nativeName": "description", "nativeType": "string" }, "displayName": { "type": "string", "nativeName": "displayName", "nativeType": "string" }, "disabledByMicrosoftStatus": { "type": "string", "nativeName": "disabledByMicrosoftStatus", "nativeType": "string" }, "groupMembershipClaims": { "type": "string", "nativeName": "groupMembershipClaims", "nativeType": "string" }, "notes": { "type": "string", "nativeName": "notes", "nativeType": "string" }, "samlMetadataUrl": { "type": "string", "nativeName": "samlMetadataUrl", "nativeType": "string" }, "serviceManagementReference": { "type": "string", "nativeName": "serviceManagementReference", "nativeType": "string" }, "signInAudience": { "type": "string", "nativeName": "signInAudience", "nativeType": "string" }, "tokenEncryptionKeyId": { "type": "string", "nativeName": "tokenEncryptionKeyId", "nativeType": "string" }, "isDeviceOnlyAuthSupported": { "type": "boolean", "nativeName": "isDeviceOnlyAuthSupported", "nativeType": "boolean" }, "isFallbackPublicClient": { "type": "boolean", "nativeName": "isFallbackPublicClient", "nativeType": "boolean" }, "oauth2RequiredPostResponse": { "type": "boolean", "nativeName": "oauth2RequiredPostResponse", "nativeType": "boolean" }, "appId": { "type": "string", "nativeName": "appId", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "createdDateTime": { "type": "string", "nativeName": "createdDateTime", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "deletedDateTime": { "type": "string", "nativeName": "deletedDateTime", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "publisherDomain": { "type": "string", "nativeName": "publisherDomain", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "identifierUris": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "identifierUris", "nativeType": "string" }, "tags": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "tags", "nativeType": "string" }, "api": { "type": "object", "nativeName": "api", "nativeType": "object" }, "optionalClaims": { "type": "object", "nativeName": "optionalClaims", "nativeType": "object" }, "parentalControlSettings": { "type": "object", "nativeName": "parentalControlSettings", "nativeType": "object" }, "publicClient": { "type": "object", "nativeName": "publicClient", "nativeType": "object" }, "spa": { "type": "object", "nativeName": "spa", "nativeType": "object" }, "verifiedPublisher": { "type": "object", "nativeName": "verifiedPublisher", "nativeType": "object" }, "web": { "type": "object", "nativeName": "web", "nativeType": "object" }, "info": { "type": "object", "nativeName": "info", "nativeType": "object" }, "certification": { "type": "object", "nativeName": "certification", "nativeType": "object", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "addIns": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "addIns", "nativeType": "object" }, "appRoles": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "appRoles", "nativeType": "object" }, "keyCredentials": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "keyCredentials", "nativeType": "object" }, "passwordCredentials": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "passwordCredentials", "nativeType": "object" }, "requiredResourceAccess": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "requiredResourceAccess", "nativeType": "object" }, }
servicePrincipal resource type
The following example configuration shows the format required for a servicePrincipal resource type:
"$schema": "http://json-schema.org/draft-03/schema", "id": "servicePrincipal", "type": "object", "nativeType": "servicePrincipal", "properties": { "appDescription": { "type": "string", "nativeName": "appDescription", "nativeType": "string" }, "appDisplayName": { "type": "string", "nativeName": "appDisplayName", "nativeType": "string" }, "appOwnerOrganizationId": { "type": "string", "nativeName": "appOwnerOrganizationId", "nativeType": "string" }, "description": { "type": "string", "nativeName": "description", "nativeType": "string" }, "displayName": { "type": "string", "nativeName": "displayName", "nativeType": "string" }, "disabledByMicrosoftStatus": { "type": "string", "nativeName": "disabledByMicrosoftStatus", "nativeType": "string" }, "homepage": { "type": "string", "nativeName": "homepage", "nativeType": "string" }, "loginUrl": { "type": "string", "nativeName": "loginUrl", "nativeType": "string" }, "logoutUrl": { "type": "string", "nativeName": "logoutUrl", "nativeType": "string" }, "notes": { "type": "string", "nativeName": "notes", "nativeType": "string" }, "preferredSingleSignOnMode": { "type": "string", "nativeName": "preferredSingleSignOnMode", "nativeType": "string" }, "servicePrincipalType": { "type": "string", "nativeName": "servicePrincipalType", "nativeType": "string" }, "tokenEncryptionKeyId": { "type": "string", "nativeName": "tokenEncryptionKeyId", "nativeType": "string" }, "accountEnabled": { "type": "boolean", "nativeName": "accountEnabled", "nativeType": "boolean" }, "appRoleAssignmentRequired": { "type": "boolean", "nativeName": "appRoleAssignmentRequired", "nativeType": "boolean" }, "appId": { "type": "string", "nativeName": "appId", "nativeType": "string" }, "applicationTemplateId": { "type": "string", "nativeName": "applicationTemplateId", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "deletedDateTime": { "type": "string", "nativeName": "deletedDateTime", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "signInAudience": { "type": "string", "nativeName": "signInAudience", "nativeType": "string", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "alternativeNames": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "alternativeNames", "nativeType": "string" }, "notificationEmailAddresses": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "notificationEmailAddresses", "nativeType": "string" }, "replyUrls": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "replyUrls", "nativeType": "string" }, "servicePrincipalNames": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "servicePrincipalNames", "nativeType": "string" }, "tags": { "type": "array", "items": { "type": "string", "nativeType": "string" }, "nativeName": "tags", "nativeType": "string" }, "samlSingleSignOnSettings": { "type": "object", "nativeName": "samlSingleSignOnSettings", "nativeType": "object" }, "verifiedPublisher": { "type": "object", "nativeName": "verifiedPublisher", "nativeType": "object" }, "info": { "type": "object", "nativeName": "info", "nativeType": "object" }, "resourceSpecificApplicationPermissions": { "type": "array", "items": { "type": "object", "nativeType": "object", }, "nativeName": "resourceSpecificApplicationPermissions", "nativeType": "object", "flags": [ "NOT_CREATABLE", "NOT_UPDATABLE" ] }, "addIns": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "addIns", "nativeType": "object" }, "appRoles": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "appRoles", "nativeType": "object" }, "keyCredentials": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "keyCredentials", "nativeType": "object" }, "passwordCredentials": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "passwordCredentials", "nativeType": "object" }, "oauth2PermissionScopes": { "type": "array", "items": { "type": "object", "nativeType": "object" }, "nativeName": "oauth2PermissionScopes", "nativeType": "object" }, }
See Also
Microsoft Graph API Java connector
Microsoft Graph application resource type
Microsoft Graph servicePrincipal resource type
Related Training
N/A