Identity Provider - List Secrets

Dienst:

API Management

API-Version:

2024-05-01

Ruft die geheimen Clientschlüsseldetails des Identitätsanbieters ab.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
identityProviderName	path	True	IdentityProviderType	Id des Identitätsanbietertyps.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ClientSecretContract	Der Antworttext enthält den geheimen Clientschlüssel. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementIdentityProviderListSecrets

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "clientSecret": "XXXXXXX"
}

Definitionen

Name	Beschreibung
ClientSecretContract	Client- oder App-Geheimschlüssel, der in IdentityProviders, Aad, OpenID oder OAuth verwendet wird.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IdentityProviderType	Id des Identitätsanbietertyps.

ClientSecretContract

Objekt

Client- oder App-Geheimschlüssel, der in IdentityProviders, Aad, OpenID oder OAuth verwendet wird.

Name	Typ	Beschreibung
clientSecret	string	Client- oder App-Geheimschlüssel, der in IdentityProviders, Aad, OpenID oder OAuth verwendet wird.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IdentityProviderType

Enumeration

Id des Identitätsanbietertyps.

Wert	Beschreibung
aad	Azure Active Directory als Identitätsanbieter.
aadB2C	Azure Active Directory B2C als Identitätsanbieter.
facebook	Facebook als Identitätsanbieter.
google	Google als Identitätsanbieter.
microsoft	Microsoft Live as Identity-Anbieter.
twitter	Twitter als Identitätsanbieter.