Authorization Server - List Secrets

Service:

API Management

API Version:

2022-08-01

권한 부여 서버의 클라이언트 암호 세부 정보를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
authsid	path	True	string	권한 부여 서버의 식별자입니다. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serviceName	path	True	string	API Management 서비스의 이름입니다. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	AuthorizationServerSecretsContract	지정된 권한 부여 서버의 비밀을 가져옵니다. Headers ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

ApiManagementAuthorizationServerListSecrets

Sample Request

HTTP

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

Java

/** Samples for AuthorizationServer ListSecrets. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementAuthorizationServerListSecrets.json
     */
    /**
     * Sample code: ApiManagementAuthorizationServerListSecrets.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementAuthorizationServerListSecrets(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .authorizationServers()
            .listSecretsWithResponse("rg1", "apimService1", "newauthServer2", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_authorization_server_list_secrets.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.authorization_server.list_secrets(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer2",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementAuthorizationServerListSecrets.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementAuthorizationServerListSecrets.json
func ExampleAuthorizationServerClient_ListSecrets() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationServerClient().ListSecrets(ctx, "rg1", "apimService1", "newauthServer2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationServerSecretsContract = armapimanagement.AuthorizationServerSecretsContract{
	// 	ClientSecret: to.Ptr("2"),
	// 	ResourceOwnerPassword: to.Ptr("pwd"),
	// 	ResourceOwnerUsername: to.Ptr("un"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the client secret details of the authorization server.
 *
 * @summary Gets the client secret details of the authorization server.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementAuthorizationServerListSecrets.json
 */
async function apiManagementAuthorizationServerListSecrets() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer2";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.listSecrets(
    resourceGroupName,
    serviceName,
    authsid
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "clientSecret": "2",
  "resourceOwnerUsername": "un",
  "resourceOwnerPassword": "pwd"
}

정의

Name	Description
AuthorizationServerSecretsContract	OAuth 서버 비밀 계약.
ErrorFieldContract	오류 필드 계약입니다.
ErrorResponse	오류 응답.

AuthorizationServerSecretsContract

OAuth 서버 비밀 계약.

Name	형식	Description
clientSecret	string	oAuth 권한 부여 서버 비밀.
resourceOwnerPassword	string	이 권한 부여 서버에서 리소스 소유자 암호 권한 유형이 지원되는 경우 선택적으로 지정할 수 있습니다. 기본 리소스 소유자 암호입니다.
resourceOwnerUsername	string	이 권한 부여 서버에서 리소스 소유자 암호 권한 유형이 지원되는 경우 선택적으로 지정할 수 있습니다. 기본 리소스 소유자 사용자 이름입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.