AgentIdentityBlueprint.AddRemoveCreds.All

Permission Details

Application Permission

Update agent identity blueprint credentials

Allows updating agent identity blueprint credentials without a signed-in user.

Permission ID: 0510736e-bdfb-4b37-9a1f-89b4a074763a

Delegated Permission

Update agent identity blueprint credentials

Allows updating agent identity blueprint credentials on behalf of the signed-in user.

Permission ID: 75b5feb2-bfe7-423f-907d-cc505186f246

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`api`	`apiApplication`	Specifies settings for an agent identity blueprint that implements a web API. Inherited from application.
`appId`	`String`Nullable	The unique identifier for the agent identity blueprint that is assigned by Microsoft Entra ID. Not nullable. Read-only. Inherited from application.
`appRoles`	`appRole collection`	The collection of roles defined for the agent identity blueprint. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. Inherited from application.
`certification`	`certification`	Specifies the certification status of the agent identity blueprint. Inherited from application.
`createdByAppId`	`String`Nullable	The appId of the application that created this agent identity blueprint. Set internally by Microsoft Entra ID. Read-only. Inherited from application.
`createdDateTime`	`DateTimeOffset`Nullable	The date and time the agent identity blueprint was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. Read-only. Inherited from application.
`description`	`String`Nullable	Free text field to provide a description of the agent identity blueprint to end users. The maximum allowed size is 1,024 characters. Inherited from application.
`disabledByMicrosoftStatus`	`String`Nullable	Specifies whether Microsoft has disabled the registered agent identity blueprint. The possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Inherited from application.
`displayName`	`String`Nullable	The display name for the agent identity blueprint. Maximum length is 256 characters. Inherited from application.
`groupMembershipClaims`	`String`Nullable	Configures the groups claim issued in a user or OAuth 2.0 access token that the agent identity blueprint expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Microsoft Entra roles), All (this gets all security groups, distribution groups, and Microsoft Entra directory roles that the signed-in user is a member of). Inherited from application.
`id`	`String`	Unique identifier for the agent identity blueprint object. This property is referred to as Object ID in the Microsoft Entra admin center. Key. Not nullable. Read-only. Inherited from directoryObject.
`identifierUris`	`String collection`	Also known as App ID URI, this value is set when an agent identity blueprint 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. Not nullable. Inherited from application.
`info`	`informationalUrl`	Basic profile information of the agent identity blueprint, such as it'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. Inherited from application.
`keyCredentials`	`keyCredential collection`	The collection of key credentials associated with the agent identity blueprint. Not nullable. Inherited from application.
`optionalClaims`	`optionalClaims`	Application developers can configure optional claims in their Microsoft Entra agent identity blueprints to specify the claims that are sent to their application by the Microsoft security token service. Inherited from application.

Showing 15 of 55 properties.

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@odata.type": "#microsoft.graph.agentIdentityBlueprint",
  "id": "String (identifier)",
  "appId": "String",
  "identifierUris": [
    "String"
  ],
  "createdByAppId": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "groupMembershipClaims": "String",
  "publisherDomain": "String",
  "requiredResourceAccess": [
    {
      "@odata.type": "microsoft.graph.requiredResourceAccess"
    }
  ],
  "signInAudience": "String",
  "tags": [
    "String"
  ],
  "tokenEncryptionKeyId": "Guid",
  "uniqueName": "String",
  "serviceManagementReference": "String",
  "certification": {
    "@odata.type": "microsoft.graph.certification"
  },
  "optionalClaims": {
    "@odata.type": "microsoft.graph.optionalClaims"
  },
  "api": {
    "@odata.type": "microsoft.graph.apiApplication"
  },
  "appRoles": [
    {
      "@odata.type": "microsoft.graph.appRole"
    }
  ],
  "info": {
    "@odata.type": "microsoft.graph.informationalUrl"
  },
  "keyCredentials": [
    {
      "@odata.type": "microsoft.graph.keyCredential"
    }
  ],
  "passwordCredentials": [
    {
      "@odata.type": "microsoft.graph.passwordCredential"
    }
  ],
  "verifiedPublisher": {
    "@odata.type": "microsoft.graph.verifiedPublisher"
  },
  "web": {
    "@odata.type": "microsoft.graph.webApplication"
  }
}

Relationships

Microsoft Graph v1.0 exact-category-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship	Type	Description
`appManagementPolicies`	`appManagementPolicy collection`	The appManagementPolicy applied to this agent identity blueprint. Inherited from microsoft.graph.application
`federatedIdentityCredentials`	`federatedIdentityCredential collection`	Federated identities for agent identity blueprints. Inherited from microsoft.graph.application
`inheritablePermissions`	`inheritablePermission collection`	Defines scopes of a resource application that may be automatically granted to agent identities without additional consent.
`owners`	`directoryObject collection`	Directory objects that are owners of this agent identity blueprint. The owners are a set of nonadmin users or service principals allowed to modify this object. Read-only. Nullable. Inherited from microsoft.graph.application
`sponsors`	`directoryObject collection`	The sponsors for this agent identity blueprint. Sponsors are users or groups who can authorize and manage the lifecycle of agent identity instances. Required during the create operation.
`appRoles`	`appRole collection`	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.
`extensionProperties`	`extensionProperty collection`	Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0).
`homeRealmDiscoveryPolicies`	`homeRealmDiscoveryPolicy collection`	Related homeRealmDiscoveryPolicies data exposed by this resource.
`identifierUris`	`string collection`	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).
`keyCredentials`	`keyCredential collection`	The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le).
`passwordCredentials`	`passwordCredential collection`	The collection of password credentials associated with the application. Not nullable.
`requiredResourceAccess`	`requiredResourceAccess collection`	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).
`signInAudienceRestrictions`	`signInAudienceRestrictionsBase`	Related signInAudienceRestrictions data exposed by this resource.
`tags`	`string collection`	Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here also appear in the tags property of any associated service principals.Supports $filter (eq, not, ge, le, startsWith) and $search.
`tokenEncryptionKeyId`	`uuid`	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.
`tokenIssuancePolicies`	`tokenIssuancePolicy collection`	Related tokenIssuancePolicies data exposed by this resource.
`tokenLifetimePolicies`	`tokenLifetimePolicy collection`	The tokenLifetimePolicies assigned to this application. Supports $expand.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey`
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/addPassword`
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/removeKey`
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/removePassword`
PATCH `/applications(appId='{appId}')`
PATCH `/applications/{applicationObjectId}`
PATCH `/applications/{id}/microsoft.graph.agentIdentityBlueprint`
PUT `/applications(appId='{appId}')/logo`
PUT `/applications/{applicationObjectId}/logo`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey`
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/addPassword`
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/removeKey`
POST `/applications/{id}/microsoft.graph.agentIdentityBlueprint/removePassword`
PATCH `/applications(appId='{appId}')`
PATCH `/applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}`
PATCH `/applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}`
PATCH `/applications/{applicationObjectId}`
PATCH `/applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}`
PATCH `/applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}`
PATCH `/applications/{id}/microsoft.graph.agentIdentityBlueprint`
PATCH `/applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/{federatedIdentityCredentialId}`
PATCH `/applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/{federatedIdentityCredentialName}`
PUT `/applications(appId='{appId}')/logo`
PUT `/applications/{applicationObjectId}/logo`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Update-MgApplication` /applications/{applicationObjectId} Update application

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Update-MgBetaApplication` /applications/{applicationObjectId} Update application
`Update-MgBetaApplicationFederatedIdentityCredential` /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId} Update federatedIdentityCredential

Code Examples

C# / .NET SDK

Update application

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Application
{
	DisplayName = "New display name",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Applications["{application-id}"].PatchAsync(requestBody);

JavaScript

agentIdentityBlueprint: addKey

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

const keyCredential = {
  keyCredential: {
    '@odata.type': 'microsoft.graph.keyCredential'
  },
  passwordCredential: {
    '@odata.type': 'microsoft.graph.passwordCredential'
  },
  proof: 'String'
};

await client.api('/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey')
	.post(keyCredential);

PowerShell

Update application

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Applications

$params = @{
	displayName = "New display name"
}

Update-MgApplication -ApplicationId $applicationId -BodyParameter $params

Python

Update application

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.application import Application
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Application(
	display_name = "New display name",
)

result = await graph_client.applications.by_application_id('application-id').patch(request_body)

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or delegated permissions and search for AgentIdentityBlueprint.AddRemoveCreds.All

4

Grant Admin Consent

Application permissions always require admin consent.