Share via

Federated Identity Credentials - List

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

Lists all the federated identity credentials under the specified user assigned identity.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials?api-version=2024-11-30
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials?api-version=2024-11-30&$top={$top}&$skiptoken={$skiptoken}

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.
resourceName
 path True

string

The name of the identity resource.
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.
$skiptoken
 query

string

A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
$top
 query

integer (int32)

minimum: 1

Number of records to return.

Responses

Name Type Description
200 OK

FederatedIdentityCredentialsListResult

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

FederatedIdentityCredentialList

Sample request

GET https://management.azure.com/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourceGroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2024-11-30

Sample response

Status code:
200 
{
  "nextLink": "https://serviceRoot/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2024-11-30&$skipToken=X'12345'",
  "value": [
    {
      "name": "ficResourceName",
      "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials",
      "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName",
      "properties": {
        "audiences": [
          "api://AzureADTokenExchange"
        ],
        "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
        "subject": "system:serviceaccount:ns:svcaccount"
      }
    }
  ]
}

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.
FederatedIdentityCredential

Describes a federated identity credential.
FederatedIdentityCredentialsListResult

Values returned by the List operation for federated identity credentials.
systemData

Metadata pertaining to creation and last modification of the resource.

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

FederatedIdentityCredential

Object

Describes a federated identity credential.

Name Type Description
id

string (arm-id)

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

string

The name of the resource
properties.audiences

string[]

The list of audiences that can appear in the issued token.
properties.issuer

string (uri)

The URL of the issuer to be trusted.
properties.subject

string

The identifier of the external identity.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

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

FederatedIdentityCredentialsListResult

Object

Values returned by the List operation for federated identity credentials.

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

FederatedIdentityCredential[]

The FederatedIdentityCredential items on this page

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.