Obtenir les autorisations client

Récupérer la liste des autorisations client, y compris les portées associées à la paire application/API.

GET https://{tenantDomain}/api/v2/client-grants

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.ClientGrants.ListAsync(
            new ListClientGrantsRequestParameters {
                From = "from",
                Take = 1,
                Audience = "audience",
                ClientId = "client_id",
                AllowAnyOrganization = true,
                SubjectType = ClientGrantSubjectTypeEnum.Client,
                DefaultFor = ClientGrantDefaultForEnum.ThirdPartyClients
            }
        );
    }

}

200

[
  {
    "allow_all_scopes": true,
    "allow_any_organization": true,
    "audience": "<string>",
    "authorization_details_types": [
      "<string>"
    ],
    "client_id": "<string>",
    "default_for": "third_party_clients",
    "id": "<string>",
    "is_system": true,
    "scope": [
      "<string>"
    ]
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

per_page · integer

Nombre de résultats par page.

Plage requise: 1 <= x <= 100

page · integer

Index de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

include_totals · boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou dans un tableau de résultats direct (false, valeur par défaut).

from · string

ID facultatif à partir duquel commencer la sélection.

take · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

audience · string

Filtre facultatif sur l’audience.

client_id · string

Filtre facultatif sur client_id.

allow_any_organization · enum<boolean>

Filtre facultatif sur allow_any_organization.

Options disponibles: true

subject_type · enum<string>

Le type d’accès à l’application qu’autorise l’autorisation client. Le type d’accès à l’application permis par ce client grant.

Options disponibles: client, user, anonymous_user

default_for · enum<string> · GA

Applique cette autorisation client par défaut à tous les clients du groupe spécifié. La seule valeur acceptée est third_party_clients, ce qui applique l’autorisation à tous les clients tiers. Les autorisations par client pour la même audience ont préséance. Ne peut pas être utilisé avec client_id. Applique ce client grant par défaut à tous les clients du groupe indiqué. La seule valeur acceptée est third_party_clients, qui applique le grant à tous les clients tiers. Les client grants par client pour la même audience ont préséance. S’exclut mutuellement avec client_id.

Options disponibles: third_party_clients

Réponse

200

application/json

Autorisations client récupérées avec succès.

Option 1 · object[]

Option 2 · object

Option 3 · object

allow_all_scopes · boolean

Si cette option est activée, tous les scopes configurés sur le resource server sont autorisés pour ce grant.

allow_any_organization · boolean

Si cette option est activée, n’importe quelle organisation peut être utilisée avec ce grant. Si elle est désactivée (par défaut), le grant doit être explicitement attribué aux organisations souhaitées.

audience · string

L’audience (identifiant d’API) de ce client grant.

Minimum string length: 1

authorization_details_types · string[]

Types de authorization_details autorisés pour ce client grant.

Required string length: 1 - 255

client_id · string

ID du client.

default_for · enum<string> · GA

Applique ce client grant par défaut à tous les clients du groupe indiqué. La seule valeur acceptée est third_party_clients, qui applique le grant à tous les clients tiers. Les client grants par client pour la même audience ont préséance. S’exclut mutuellement avec client_id.

Options disponibles: third_party_clients

id · string

ID du client grant.

is_system · boolean

Si cette option est activée, ce grant est un grant spécial créé par Auth0. Il ne peut pas être modifié ni supprimé directement.

organization_usage · enum<string>

Définit si les organizations peuvent être utilisées avec les échanges client credentials pour ce grant.

Options disponibles: deny, allow, require

scope · string[]

Scopes autorisés pour ce client grant.

Minimum string length: 1

subject_type · enum<string>

Le type d’accès à l’application permis par ce client grant.

Options disponibles: client, user, anonymous_user