Freigeben über


Api Management Service - Get Sso Token

Ruft das Token für einmaliges Anmelden für den API Management Dienst ab, das 5 Minuten lang gültig ist.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken?api-version=2022-08-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

ApiManagementServiceGetSsoTokenResult

OK, wenn der SSO-Umleitungs-URI erfolgreich ist.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementServiceGetSsoToken

Beispielanforderung

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/getssotoken?api-version=2022-08-01

Beispiel für eine Antwort

{
  "redirectUri": "https://apimService1.portal.azure-api.net:443/signin-sso?token=1%26201705301929%26eIkr3%2fnfaLs1GVJ0OVbzkJjAcwPFkEZAPM8VUXvXPf7cJ6lWsB9oUwsk2zln9x0KLkn21txCPJWWheSPq7SNeA%3d%3d"
}

Definitionen

Name Beschreibung
ApiManagementServiceGetSsoTokenResult

Die Antwort des GetSsoToken-Vorgangs.

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

ApiManagementServiceGetSsoTokenResult

Die Antwort des GetSsoToken-Vorgangs.

Name Typ Beschreibung
redirectUri

string

Leiten Sie die URL an das Herausgeberportal um, das das SSO-Token enthält.

ErrorFieldContract

Fehlerfeldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.

message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.

target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.

error.message

string

Lesbare Darstellung des Fehlers.