Federated Identity Credentials - List
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=2023-01-31
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials?$top={$top}&$skiptoken={$skiptoken}&api-version=2023-01-31
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the Resource Group to which the identity belongs. |
resource
|
path | True |
string |
The name of the identity resource. |
subscription
|
path | True |
string |
The Id of the Subscription to which the identity belongs. |
api-version
|
query | True |
string |
Version of API to invoke. |
$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 |
Number of records to return. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. The list of federated identity credentials for the specified user assigned identity was retrieved and returned successfully. |
|
Other Status Codes |
Error response describing why the operation failed. |
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
Sample response
{
"value": [
{
"id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName",
"name": "ficResourceName",
"properties": {
"issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
"subject": "system:serviceaccount:ns:svcaccount",
"audiences": [
"api://AzureADTokenExchange"
]
},
"type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials"
}
],
"nextLink": "https://serviceRoot/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2023-01-31&$skipToken=X'12345'"
}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the ManagedServiceIdentity service. |
Cloud |
An error response from the ManagedServiceIdentity service. |
created |
The type of identity that created the resource. |
Federated |
Describes a federated identity credential. |
Federated |
Values returned by the List operation for federated identity credentials. |
system |
Metadata pertaining to creation and last modification of the resource. |
CloudError
An error response from the ManagedServiceIdentity service.
Name | Type | Description |
---|---|---|
error |
A list of additional details about the error. |
CloudErrorBody
An error response from the ManagedServiceIdentity service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. |
details |
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
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
FederatedIdentityCredential
Describes a federated identity credential.
Name | Type | Description |
---|---|---|
id |
string |
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 |
The URL of the issuer to be trusted. |
properties.subject |
string |
The identifier of the external identity. |
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
Values returned by the List operation for federated identity credentials.
Name | Type | Description |
---|---|---|
nextLink |
string |
The url to get the next page of results, if any. |
value |
The collection of federated identity credentials returned by the listing operation. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |