Share via


Authorization - List By Authorization Provider

Visar en samling auktoriseringsprovidrar som definierats i en auktoriseringsprovider.

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

URI-parametrar

Name I Obligatorisk Typ Description
authorizationProviderId
path True

string

Identifierare för auktoriseringsprovidern.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

$filter
query

string

| Fält | Användning | Operatorer som stöds | Funktioner som stöds |
|-------------|-------------|-------------|-------------|
| namn | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query

integer

int32

Antal poster att hoppa över.

$top
query

integer

int32

Antal poster som ska returneras.

Svar

Name Typ Description
200 OK

AuthorizationCollection

En samling auktoriseringsentiteter för den angivna auktoriseringsprovidern.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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 personifiera ditt användarkonto

Exempel

ApiManagementListAuthorizationsAuthCode
ApiManagementListAuthorizationsClientCred

ApiManagementListAuthorizationsAuthCode

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz1",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "AuthorizationCode",
        "status": "Connected"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz2",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "AuthorizationCode",
        "status": "Error",
        "error": {
          "code": "Unauthenticated",
          "message": "This connection is not authenticated."
        }
      }
    }
  ],
  "nextLink": ""
}

ApiManagementListAuthorizationsClientCred

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz1",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "ClientCredentials",
        "parameters": {
          "clientId": "53790925-fdd3-4b80-bc7a-4c3aaf25801d"
        },
        "status": "Connected"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz2",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz2",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "ClientCredentials",
        "parameters": {
          "clientId": "53790925-fdd3-4b80-bc7a-4c3aaf25801d"
        },
        "status": "Error",
        "error": {
          "code": "Unauthorized",
          "message": "Failed to acquire access token for service using client credentials flow: IdentityProvider=aadwithclientcred. Correlation Id=6299d09b-03b7-46ed-b355-0453451d7e49, UTC TimeStamp=5/14/2022 4:53:19 PM, Error: Failed to exchange client credentials for token. Response code=Unauthorized, Details:\r\n{\"error\":\"invalid_client\",\"error_description\":\"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app '53790925-fdd3-4b80-bc7a-4c3aaf25801d'.\\r\\nTrace ID: 4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\\r\\nCorrelation ID: dde60c16-35cb-4572-8226-bfb4233af8d7\\r\\nTimestamp: 2022-05-14 16:53:19Z\",\"error_codes\":[7000215],\"timestamp\":\"2022-05-14 16:53:19Z\",\"trace_id\":\"4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\",\"correlation_id\":\"dde60c16-35cb-4572-8226-bfb4233af8d7\",\"error_uri\":\"https://login.windows.net/error?code=7000215\"}"
        }
      }
    }
  ],
  "nextLink": ""
}

Definitioner

Name Description
AuthorizationCollection

Sidrepresentation av auktoriseringslista.

AuthorizationContract

Auktoriseringskontrakt.

AuthorizationError

Information om auktoriseringsfel.

AuthorizationType

Alternativ för auktoriseringstyp

ErrorFieldContract

Fel Fältkontrakt.

ErrorResponse

Felsvar.

OAuth2GrantType

Alternativ för OAuth2-beviljandetyp

AuthorizationCollection

Sidrepresentation av auktoriseringslista.

Name Typ Description
count

integer

Totalt antal poster på alla sidor.

nextLink

string

Om det finns någon länk till nästa sida.

value

AuthorizationContract[]

Sidvärden.

AuthorizationContract

Auktoriseringskontrakt.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.authorizationType

AuthorizationType

Alternativ för auktoriseringstyp

properties.error

AuthorizationError

properties.oauth2grantType

OAuth2GrantType

Alternativ för OAuth2-beviljandetyp

properties.parameters

object

Auktoriseringsparametrar

properties.status

string

Status för auktoriseringen

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

AuthorizationError

Information om auktoriseringsfel.

Name Typ Description
code

string

Felkod

message

string

Felmeddelande

AuthorizationType

Alternativ för auktoriseringstyp

Name Typ Description
OAuth2

string

Auktoriseringstyp för OAuth2

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.

error.message

string

Mänsklig läsbar representation av felet.

OAuth2GrantType

Alternativ för OAuth2-beviljandetyp

Name Typ Description
AuthorizationCode

string

Bevilja auktoriseringskod

ClientCredentials

string

Beviljande av klientautentiseringsuppgifter