Edit

Share via

Get agentIdentityBlueprintPrincipal

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Read the properties and relationships of agentIdentityBlueprintPrincipal object.

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 permission Higher privileged permissions
Delegated (work or school account) AgentIdentityBlueprintPrincipal.Read.All Application.Read.All, Directory.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application AgentIdentityBlueprintPrincipal.Read.All Application.Read.All, Directory.Read.All

Important

The AgentIdentity* permissions are currently unavailable for consent through the API permissions experience on the Microsoft Entra admin center. To use these permissions, you can consent to them through Microsoft Graph API calls as described in Grant or revoke API permissions programmatically. See Permissions for managing agent identities for more information about these permissions.

When using delegated permissions, the authenticated user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Agent ID Administrator.
  • Agent ID Developer - Create agent identity blueprints. The principal with this role is assigned ownership of the blueprint they create and can perform write operations on that blueprint.

HTTP request

You can address the agent identity blueprint principal using either its id or appId.

GET /servicePrincipals/{id}/microsoft.graph.agentIdentityBlueprintPrincipal
GET /servicePrincipals(appId='{appId}')/microsoft.graph.agentIdentityBlueprintPrincipal

Optional query parameters

This method supports the $count, $expand, $filter, $orderby, $search, $select, and $top OData query parameters to help customize the response. Some queries are supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.

By default, this API doesn't return the public key value of the key in the keyCredentials property unless keyCredentials is specified in a $select query. For example, $select=id,appId,keyCredentials.

The use of $select to get keyCredentials for agent blueprint principals has a throttling limit of 150 requests per minute for every tenant.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept-Language Language code. Optional.

Providing the Accept-Language header with a supported language code, such as es-ES or de-DE, returns localized values where available.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an agentIdentityBlueprintPrincipal object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/servicePrincipals/{id}/microsoft.graph.agentIdentityBlueprintPrincipal

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "microsoft.graph.agentIdentityBlueprintPrincipal",
    "id": "f7c938db-8c3d-4d04-937b-456c3242ed95",
    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "createdDateTime": "2019-09-17T19:10:35.2742618Z",
    "accountEnabled": true,
    "appDisplayName": "My Sample App",
    "appOwnerOrganizationId": "65415bb1-9267-4313-bbf5-ae259732ee12",
    "appRoleAssignmentRequired": false,
    "appRoles": [],
    "disabledByMicrosoftStatus": null,
    "info": {
        "termsOfServiceUrl": null,
        "supportUrl": null,
        "privacyStatementUrl": null,
        "marketingUrl": null,
        "logoUrl": null
    },
    "oauth2PermissionScopes": [],
    "servicePrincipalType": "Application",
    "tags": [],
    "verifiedPublisher": null
}
  • Last updated on