Authorization Provider - List By Service

서비스:: API Management

API 버전:: 2024-05-01

서비스 인스턴스 내에 정의된 권한 부여 공급자의 컬렉션을 나열합니다.

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

선택적 매개 변수:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
$filter	query		string	\| 필드 \| 사용량 \| 지원되는 연산자 \| 지원되는 함수 \| \|-------------\|-------------\|-------------\|-------------\| \| name \| 필터 \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| displayName \| 필터 \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	건너뛸 레코드 수입니다.
$top	query		integer (int32) minimum: 1	반환할 레코드 수입니다.

응답

Name	형식	Description
200 OK	AuthorizationProviderCollection	지정된 API Management 서비스 인스턴스에 대한 권한 부여 공급자 엔터티의 컬렉션입니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementListAuthorizationProviders

샘플 요청

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders?api-version=2024-05-01

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "aadwithauthcode",
      "properties": {
        "displayName": "aadwithauthcode",
        "identityProvider": "aad",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "authorizationCode": {
              "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d",
              "scopes": "User.Read.All Group.Read.All",
              "loginUri": "https://login.windows.net",
              "resourceUri": "https://graph.microsoft.com",
              "tenantId": "common"
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "aadwithclientcred",
      "properties": {
        "displayName": "aadwithclientcred",
        "identityProvider": "aad",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "clientCredentials": {
              "scopes": "User.Read.All Group.Read.All",
              "loginUri": "https://login.windows.net",
              "resourceUri": "https://graph.microsoft.com",
              "tenantId": "common"
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "google",
      "properties": {
        "displayName": "google",
        "identityProvider": "google",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "authorizationCode": {
              "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
              "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email"
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "eventbrite",
      "properties": {
        "displayName": "eventbrite",
        "identityProvider": "oauth2",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "authorizationCode": {
              "clientId": "clientid",
              "scopes": null,
              "authorizationUrl": "https://www.eventbrite.com/oauth/authorize",
              "refreshUrl": "https://www.eventbrite.com/oauth/token",
              "tokenUrl": "https://www.eventbrite.com/oauth/token"
            }
          }
        }
      }
    }
  ],
  "nextLink": ""
}

정의

Name	Description
AuthorizationProviderCollection	페이징된 권한 부여 공급자 목록 표현입니다.
AuthorizationProviderContract	권한 부여 공급자 계약.
AuthorizationProviderOAuth2GrantTypes	권한 부여 공급자 oauth2 권한 부여 형식 설정
AuthorizationProviderOAuth2Settings	OAuth2 설정 세부 정보
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답

AuthorizationProviderCollection

Object

페이징된 권한 부여 공급자 목록 표현입니다.

Name	형식	Description
nextLink	string	다음 페이지 링크(있는 경우)입니다.
value	AuthorizationProviderContract[]	페이지 값입니다.

AuthorizationProviderContract

Object

권한 부여 공급자 계약.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.displayName	string minLength: 1 maxLength: 300	권한 부여 공급자 이름입니다. 길이는 1~300자여야 합니다.
properties.identityProvider	string	ID 공급자 이름입니다. 길이는 1~300자여야 합니다.
properties.oauth2	AuthorizationProviderOAuth2Settings	OAuth2 설정
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

AuthorizationProviderOAuth2GrantTypes

Object

권한 부여 공급자 oauth2 권한 부여 형식 설정

Name	형식	Description
authorizationCode	object	OAuth2 권한 부여 코드 부여 매개 변수
clientCredentials	object	OAuth2 클라이언트 자격 증명 부여 매개 변수

AuthorizationProviderOAuth2Settings

Object

OAuth2 설정 세부 정보

Name	형식	Description
grantTypes	AuthorizationProviderOAuth2GrantTypes	OAuth2 설정
redirectUrl	string	OAuth 애플리케이션에서 설정할 리디렉션 URL입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

다음을 통해 공유

Authorization Provider - List By Service

URI 매개 변수

응답

보안

azure_auth

범위

예제

ApiManagementListAuthorizationProviders

샘플 요청

샘플 응답

정의

AuthorizationProviderCollection

AuthorizationProviderContract

AuthorizationProviderOAuth2GrantTypes

AuthorizationProviderOAuth2Settings

ErrorAdditionalInfo

ErrorDetail

ErrorResponse