Identity Provider - List Secrets

服務:

API Management

API 版本:

2024-05-01

取得識別提供者的客戶端密碼詳細數據。

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

URI 參數

名稱	位於	必要	類型	Description
identityProviderName	path	True	IdentityProviderType	識別提供者類型識別碼。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服務的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	ClientSecretContract	回應本文包含客戶端密碼。 標題 ETag: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementIdentityProviderListSecrets

範例要求

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

範例回覆

狀態碼:

200

{
  "clientSecret": "XXXXXXX"
}

定義

名稱	Description
ClientSecretContract	IdentityProviders、Aad、OpenID 或 OAuth 中使用的用戶端或應用程式密碼。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IdentityProviderType	識別提供者類型識別碼。

ClientSecretContract

Object

IdentityProviders、Aad、OpenID 或 OAuth 中使用的用戶端或應用程式密碼。

名稱	類型	Description
clientSecret	string	IdentityProviders、Aad、OpenID 或 OAuth 中使用的用戶端或應用程式密碼。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

IdentityProviderType

列舉型別

識別提供者類型識別碼。

值	Description
aad	Azure Active Directory 作為識別提供者。
aadB2C	Azure Active Directory B2C 作為識別提供者。
facebook	Facebook 作為身分識別提供者。
google	Google 作為身分識別提供者。
microsoft	Microsoft Live 身分識別提供者。
twitter	Twitter 作為身分識別提供者。