Share via

User Assigned Identities - List By Resource Group

Service:
Managed Identity
API Version:
2024-11-30

Lists all the userAssignedIdentities available under the specified ResourceGroup.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2024-11-30

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

UserAssignedIdentitiesListResult

The request has succeeded.
Other Status Codes

CloudError

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IdentityListByResourceGroup

Sample request

GET https://management.azure.com/subscriptions/12345678-1234-5678-9012-123456789012/resourceGroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2024-11-30

Sample response

Status code:
200 
{
  "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2024-11-30&$skiptoken=X'12345'",
  "value": [
    {
      "name": "identityName",
      "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
      "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
      "location": "eastus",
      "properties": {
        "clientId": "4024ab25-56a8-4370-aea6-6389221caf29",
        "isolationScope": "None",
        "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad",
        "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the ManagedServiceIdentity service.
CloudErrorBody

An error response from the ManagedServiceIdentity service.
createdByType

The type of identity that created the resource.
Identity

Describes an identity resource.
IsolationScope

Enum to configure regional restrictions on identity assignment, as necessary.
systemData

Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentitiesListResult

Values returned by the List operation.

CloudError

Object

An error response from the ManagedServiceIdentity service.

Name Type Description
error

CloudErrorBody

A list of additional details about the error.

CloudErrorBody

Object

An error response from the ManagedServiceIdentity service.

Name Type Description
code

string

An identifier for the error.
details

CloudErrorBody[]

A list of additional details about the error.
message

string

A message describing the error, intended to be suitable for display in a user interface.
target

string

The target of the particular error. For example, the name of the property in error.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

Identity

Object

Describes an identity resource.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location

string

The geo-location where the resource lives
name

string

The name of the resource
properties.clientId

string (uuid)

The id of the app associated with the identity. This is a random generated UUID by MSI.
properties.isolationScope

IsolationScope

Enum to configure regional restrictions on identity assignment, as necessary.
properties.principalId

string (uuid)

The id of the service principal object associated with the created identity.
properties.tenantId

string (uuid)

The id of the tenant which the identity belongs to.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

IsolationScope

Enumeration

Enum to configure regional restrictions on identity assignment, as necessary.

Value Description
None
Regional

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentitiesListResult

Object

Values returned by the List operation.

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

Identity[]

The Identity items on this page