Update a client profile

TypeScript

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

package example

import (
    context "context"

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

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

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

}

package com.example.usage;

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

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

        client.clientProfiles().update(
            "id",
            UpdateClientProfileRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ClientProfiles\Requests\UpdateClientProfileRequestContent;

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/client-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "client_configuration": {
    "refresh_token": {
      "token_lifetime": {
        "default_value": 15778800
      },
      "idle_token_lifetime": {
        "default_value": 15778800
      },
      "leeway": {
        "default_value": 1
      }
    },
    "organization_usage": {},
    "organization_require_behavior": {},
    "organization_discovery_methods": {
      "default_value": []
    },
    "require_proof_of_possession": {
      "default_value": true
    }
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "client_configuration": {
    "refresh_token": {
      "token_lifetime": {
        "default_value": 15778800
      },
      "idle_token_lifetime": {
        "default_value": 15778800
      },
      "leeway": {
        "default_value": 1
      }
    },
    "organization_usage": {
      "default_value": "deny"
    },
    "organization_require_behavior": {
      "default_value": "no_prompt"
    },
    "organization_discovery_methods": {
      "default_value": [
        "email"
      ]
    },
    "require_proof_of_possession": {
      "default_value": true
    }
  },
  "apply_policy": {
    "external_metadata_type": "cimd",
    "external_metadata_created_by": "client"
  },
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

PATCH

https://{tenantDomain}/api/v2

client-profiles

{id}

TypeScript

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

package example

import (
    context "context"

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

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

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

}

package com.example.usage;

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

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

        client.clientProfiles().update(
            "id",
            UpdateClientProfileRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ClientProfiles\Requests\UpdateClientProfileRequestContent;

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/client-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "client_configuration": {
    "refresh_token": {
      "token_lifetime": {
        "default_value": 15778800
      },
      "idle_token_lifetime": {
        "default_value": 15778800
      },
      "leeway": {
        "default_value": 1
      }
    },
    "organization_usage": {},
    "organization_require_behavior": {},
    "organization_discovery_methods": {
      "default_value": []
    },
    "require_proof_of_possession": {
      "default_value": true
    }
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "client_configuration": {
    "refresh_token": {
      "token_lifetime": {
        "default_value": 15778800
      },
      "idle_token_lifetime": {
        "default_value": 15778800
      },
      "leeway": {
        "default_value": 1
      }
    },
    "organization_usage": {
      "default_value": "deny"
    },
    "organization_require_behavior": {
      "default_value": "no_prompt"
    },
    "organization_discovery_methods": {
      "default_value": [
        "email"
      ]
    },
    "require_proof_of_possession": {
      "default_value": true
    }
  },
  "apply_policy": {
    "external_metadata_type": "cimd",
    "external_metadata_created_by": "client"
  },
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<client-profile-id>

required

ID of the client profile. Client Profile identifier.

Body

application/json

Top-level JSON Merge Patch (RFC 7386): omitted top-level fields remain unchanged. Nested objects such as client_configuration must be supplied in full.

name

string

Display name of the client profile.

Required string length: 1 - 128

Pattern: ^[^\u0000]*$

description

string | null

Optional description of the client profile.

Maximum string length: 256

Pattern: ^[^\u0000]*$

client_configuration

object

Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.

Show child attributes

apply_policy

object

Runtime matching rules that determine which clients this profile governs.

Show child attributes

Response

Client profile successfully updated.

string<client-profile-id>

required

Client Profile identifier.

name

string

required

Display name of the client profile.

Required string length: 1 - 128

Pattern: ^[^\u0000]*$

client_configuration

object

required

Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.

Show child attributes

apply_policy

object

required

Runtime matching rules that determine which clients this profile governs.

Show child attributes

description

string | null

Optional description of the client profile.

Maximum string length: 256

Pattern: ^[^\u0000]*$

created_at

string<date-time>

Timestamp of creation.

updated_at

string<date-time>

Timestamp of last update.