Compartilhar via


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=2024-05-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

uuid

The ID of the target subscription. The value must be an UUID.

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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C/listSecrets?api-version=2024-05-01

Sample response

{
  "clientSecret": "XXXXXXX"
}

Definitions

Name Description
ClientSecretContract

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

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

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.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

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.