applicationTemplate: instantiate
Namespace: microsoft.graph
Add an instance of an application from the Microsoft Entra application gallery into your directory.
The application template with ID 8adf8e6e-67b2-4cf2-a259-e3dc5476c621
can be used to add a non-gallery app that you can configure different single-sign on (SSO) modes like SAML SSO and password-based SSO.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Application.ReadWrite.All | Directory.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Application.ReadWrite.OwnedBy | Application.ReadWrite.All, Directory.ReadWrite.All |
HTTP request
POST /applicationTemplates/{applicationTemplate-id}/instantiate
To instantiate non-gallery apps, use the 8adf8e6e-67b2-4cf2-a259-e3dc5476c621
for the {applicationTemplate-id}
.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
In the request body, provide a JSON object with the following parameters.
Parameter | Type | Description |
---|---|---|
displayName | String | Custom name of the application |
Response
If successful, this method returns a 201 Created
response code and a new applicationServicePrincipal object in the response body.
Examples
The following example shows how to call this API.
Request
The following example shows a request.
POST https://graph.microsoft.com/v1.0/applicationTemplates/229946b9-a9fb-45b8-9531-efa47453ac9e/instantiate
Content-type: application/json
{
"displayName": "Azure AD SAML Toolkit"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.applicationServicePrincipal",
"application": {
"id": "20845737-a145-446f-aa3c-77d432903957",
"appId": "3c653ec4-4e4c-4820-8127-49e3889cad99",
"applicationTemplateId": "229946b9-a9fb-45b8-9531-efa47453ac9e",
"createdDateTime": "2022-04-25T16:48:24Z",
"deletedDateTime": null,
"displayName": "Azure AD SAML Toolkit",
"groupMembershipClaims": null,
"identifierUris": [],
"isFallbackPublicClient": false,
"signInAudience": "AzureADMyOrg",
"tags": [],
"tokenEncryptionKeyId": null,
"defaultRedirectUri": null,
"optionalClaims": null,
"addIns": [],
"api": {
"acceptMappedClaims": null,
"knownClientApplications": [],
"requestedAccessTokenVersion": null,
"oauth2PermissionScopes": [
{
"adminConsentDescription": "Allow the application to access Azure AD SAML Toolkit on behalf of the signed-in user.",
"adminConsentDisplayName": "Access Azure AD SAML Toolkit",
"id": "00e7ef81-4deb-41d7-9ee3-90d4eba1e991",
"isEnabled": true,
"type": "User",
"userConsentDescription": "Allow the application to access Azure AD SAML Toolkit on your behalf.",
"userConsentDisplayName": "Access Azure AD SAML Toolkit",
"value": "user_impersonation"
}
],
"preAuthorizedApplications": []
},
"appRoles": [
{
"allowedMemberTypes": [
"User"
],
"displayName": "msiam_access",
"id": "8b292bda-39b6-4b77-849e-887565235bb0",
"isEnabled": true,
"description": "msiam_access",
"value": null,
"origin": "Application"
}
],
"info": {
"logoUrl": null,
"marketingUrl": null,
"privacyStatementUrl": null,
"supportUrl": null,
"termsOfServiceUrl": null
},
"keyCredentials": [],
"parentalControlSettings": {
"countriesBlockedForMinors": [],
"legalAgeGroupRule": "Allow"
},
"passwordCredentials": [],
"publicClient": {
"redirectUris": []
},
"requiredResourceAccess": [],
"verifiedPublisher": {
"displayName": null,
"verifiedPublisherId": null,
"addedDateTime": null
},
"web": {
"homePageUrl": "https://samltoolkit.azurewebsites.net/SAML/Consume?metadata=samltoolkit|ISV9.2|primary|z",
"redirectUris": [
"https://samltoolkit.azurewebsites.net/SAML/Consume"
]
}
},
"servicePrincipal": {
"id": "912729dd-97ae-4ceb-ade4-07bed3046486",
"deletedDateTime": null,
"accountEnabled": true,
"appId": "3c653ec4-4e4c-4820-8127-49e3889cad99",
"applicationTemplateId": "229946b9-a9fb-45b8-9531-efa47453ac9e",
"appDisplayName": "Azure AD SAML Toolkit",
"alternativeNames": [],
"appOwnerOrganizationId": "29a4f813-9274-4e1b-858d-0afa98ae66d4",
"displayName": "Azure AD SAML Toolkit",
"appRoleAssignmentRequired": true,
"loginUrl": null,
"logoutUrl": null,
"homepage": "https://samltoolkit.azurewebsites.net/SAML/Consume?metadata=samltoolkit|ISV9.2|primary|z",
"notificationEmailAddresses": [],
"preferredSingleSignOnMode": null,
"preferredTokenSigningKeyThumbprint": null,
"replyUrls": [
"https://samltoolkit.azurewebsites.net/SAML/Consume"
],
"servicePrincipalNames": [
"3c653ec4-4e4c-4820-8127-49e3889cad99"
],
"servicePrincipalType": "Application",
"tags": [
"WindowsAzureActiveDirectoryIntegratedApp"
],
"tokenEncryptionKeyId": null,
"samlSingleSignOnSettings": null,
"verifiedPublisher": {
"displayName": null,
"verifiedPublisherId": null,
"addedDateTime": null
},
"addIns": [],
"appRoles": [
{
"allowedMemberTypes": [
"User"
],
"displayName": "msiam_access",
"id": "8b292bda-39b6-4b77-849e-887565235bb0",
"isEnabled": true,
"description": "msiam_access",
"value": null,
"origin": "Application"
}
],
"info": {
"logoUrl": null,
"marketingUrl": null,
"privacyStatementUrl": null,
"supportUrl": null,
"termsOfServiceUrl": null
},
"keyCredentials": [],
"oauth2PermissionScopes": [
{
"adminConsentDescription": "Allow the application to access Azure AD SAML Toolkit on behalf of the signed-in user.",
"adminConsentDisplayName": "Access Azure AD SAML Toolkit",
"id": "00e7ef81-4deb-41d7-9ee3-90d4eba1e991",
"isEnabled": true,
"type": "User",
"userConsentDescription": "Allow the application to access Azure AD SAML Toolkit on your behalf.",
"userConsentDisplayName": "Access Azure AD SAML Toolkit",
"value": "user_impersonation"
}
],
"passwordCredentials": []
}
}