Gets the client secret details of the Identity Provider.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets?api-version=2022-08-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
identityProviderName
|
path |
True
|
IdentityProviderType
|
Identity Provider Type identifier.
|
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group. The name is case insensitive.
|
|
serviceName
|
path |
True
|
string
|
The name of the API Management service.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Responses
| Name |
Type |
Description |
|
200 OK
|
ClientSecretContract
|
The response body contains the client secret.
Headers
ETag: string
|
|
Other Status Codes
|
ErrorResponse
|
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
ApiManagementIdentityProviderListSecrets
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C/listSecrets?api-version=2022-08-01
import com.azure.resourcemanager.apimanagement.models.IdentityProviderType;
/** Samples for IdentityProvider ListSecrets. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementIdentityProviderListSecrets.json
*/
/**
* Sample code: ApiManagementIdentityProviderListSecrets.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementIdentityProviderListSecrets(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager
.identityProviders()
.listSecretsWithResponse(
"rg1", "apimService1", IdentityProviderType.AAD_B2C, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import TYPE_CHECKING, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_identity_provider_list_secrets.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.identity_provider.list_secrets(
resource_group_name="rg1",
service_name="apimService1",
identity_provider_name="aadB2C",
)
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementIdentityProviderListSecrets.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementIdentityProviderListSecrets.json
func ExampleIdentityProviderClient_ListSecrets() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewIdentityProviderClient().ListSecrets(ctx, "rg1", "apimService1", armapimanagement.IdentityProviderTypeAADB2C, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ClientSecretContract = armapimanagement.ClientSecretContract{
// ClientSecret: to.Ptr("XXXXXXX"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the client secret details of the Identity Provider.
*
* @summary Gets the client secret details of the Identity Provider.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementIdentityProviderListSecrets.json
*/
async function apiManagementIdentityProviderListSecrets() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const identityProviderName = "aadB2C";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.identityProvider.listSecrets(
resourceGroupName,
serviceName,
identityProviderName
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"clientSecret": "XXXXXXX"
}
Definitions
ClientSecretContract
Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.
| Name |
Type |
Description |
|
clientSecret
|
string
|
Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.
|
ErrorFieldContract
Error Field contract.
| Name |
Type |
Description |
|
code
|
string
|
Property level error code.
|
|
message
|
string
|
Human-readable representation of property-level error.
|
|
target
|
string
|
Property name.
|
ErrorResponse
Error Response.
| Name |
Type |
Description |
|
error.code
|
string
|
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
|
|
error.details
|
ErrorFieldContract[]
|
The list of invalid fields send in request, in case of validation error.
|
|
error.message
|
string
|
Human-readable representation of the error.
|
IdentityProviderType
Identity Provider Type identifier.
| Name |
Type |
Description |
|
aad
|
string
|
Azure Active Directory as Identity provider.
|
|
aadB2C
|
string
|
Azure Active Directory B2C as Identity provider.
|
|
facebook
|
string
|
Facebook as Identity provider.
|
|
google
|
string
|
Google as Identity provider.
|
|
microsoft
|
string
|
Microsoft Live as Identity provider.
|
|
twitter
|
string
|
Twitter as Identity provider.
|