Identity Provider - List Secrets

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=2019-12-01

URI Parameters

Name In Required Type Description
identityProviderName
path True

Identity Provider Type identifier.

resourceGroupName
path True
  • string

The name of the resource group.

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

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

The response body contains the client secret.

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

ApiManagementListSecretsIdentityProvider

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C/listSecrets?api-version=2019-12-01

Sample Response

{
  "clientSecret": "XXXXXXX"
}

Definitions

ClientSecretContract

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

IdentityProviderType

Identity Provider Type identifier.

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

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.