Update client grant

Update a client grant.

PATCH https://{tenantDomain}/api/v2/client-grants/{id}

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.UpdateAsync(
            id: "id",
            request: new UpdateClientGrantRequestContent()
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateClientGrantRequestContent{}
    mgmt.ClientGrants.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateClientGrantRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.clientGrants().update(
            "id",
            UpdateClientGrantRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ClientGrants\Requests\UpdateClientGrantRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clientGrants->update(
    'id',
    new UpdateClientGrantRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.client_grants.update(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.client_grants.update(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clientGrants.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clientGrants.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/client-grants/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": [
    "<string>"
  ],
  "allow_any_organization": true,
  "authorization_details_types": [
    "<string>"
  ],
  "allow_all_scopes": true
}
'

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

ID of the client grant to update.

ボディ

application/jsonapplication/x-www-form-urlencoded

scope · string[] | null

Scopes allowed for this client grant.

Required string length: 1 - 280

organization_usage · enum<string> | null

Controls how organizations may be used with this grant

利用可能なオプション: deny, allow, require, null

allow_any_organization · boolean | null

Controls allowing any organization to be used with this grant

authorization_details_types · string[]

Types of authorization_details allowed for this client grant.

Required string length: 1 - 255

allow_all_scopes · boolean | null

If enabled, all scopes configured on the resource server are allowed for this grant.

レスポンス

200

application/json

Client grant successfully updated.

id · string

ID of the client grant.

client_id · string

ID of the client.

audience · string

The audience (API identifier) of this client grant.

Minimum string length: 1

scope · string[]

Scopes allowed for this client grant.

Minimum string length: 1

organization_usage · enum<string>

Defines whether organizations can be used with client credentials exchanges for this grant.

利用可能なオプション: deny, allow, require

allow_any_organization · boolean

If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations.

default_for · enum<string> · GA

Applies this client grant as the default for all clients in the specified group. The only accepted value is third_party_clients, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with client_id.

利用可能なオプション: third_party_clients

is_system · boolean

If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly.

subject_type · enum<string>

The type of application access the client grant allows.

利用可能なオプション: client, user

authorization_details_types · string[]

Types of authorization_details allowed for this client grant.

Required string length: 1 - 255

allow_all_scopes · boolean

If enabled, all scopes configured on the resource server are allowed for this grant.