TypeScript
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.clientProfiles.create({
name: "name",
client_configuration: {},
apply_policy: {
external_metadata_type: "cimd",
external_metadata_created_by: "client",
},
});
}
main();import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.clientProfiles.create({
name: "name",
client_configuration: {},
apply_policy: {
external_metadata_type: "cimd",
external_metadata_created_by: "client",
},
});
}
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.CreateClientProfileRequestContent{
Name: "name",
ClientConfiguration: &management.ClientProfileClientConfiguration{},
ApplyPolicy: &management.ClientProfileApplyPolicy{
ExternalMetadataType: management.ClientProfileApplyPolicyExternalMetadataTypeEnumCimd,
ExternalMetadataCreatedBy: management.ClientProfileApplyPolicyExternalMetadataCreatedByEnumClient,
},
}
mgmt.ClientProfiles.Create(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api post "client-profiles" --data '{
"name": "name",
"client_configuration": {},
"apply_policy": {
"external_metadata_type": "cimd",
"external_metadata_created_by": "client"
}
}'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.CreateAsync(
new CreateClientProfileRequestContent {
Name = "name",
ClientConfiguration = new ClientProfileClientConfiguration(),
ApplyPolicy = new ClientProfileApplyPolicy {
ExternalMetadataType = ClientProfileApplyPolicyExternalMetadataTypeEnum.Cimd,
ExternalMetadataCreatedBy = ClientProfileApplyPolicyExternalMetadataCreatedByEnum.Client
}
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ClientProfileApplyPolicy;
import com.auth0.client.mgmt.types.ClientProfileApplyPolicyExternalMetadataCreatedByEnum;
import com.auth0.client.mgmt.types.ClientProfileApplyPolicyExternalMetadataTypeEnum;
import com.auth0.client.mgmt.types.ClientProfileClientConfiguration;
import com.auth0.client.mgmt.types.CreateClientProfileRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.clientProfiles().create(
CreateClientProfileRequestContent
.builder()
.name("name")
.clientConfiguration(
ClientProfileClientConfiguration
.builder()
.build()
)
.applyPolicy(
ClientProfileApplyPolicy
.builder()
.externalMetadataType(ClientProfileApplyPolicyExternalMetadataTypeEnum.CIMD)
.externalMetadataCreatedBy(ClientProfileApplyPolicyExternalMetadataCreatedByEnum.CLIENT)
.build()
)
.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\CreateClientProfileRequestContent;
use Auth0\SDK\API\Management\Types\ClientProfileClientConfiguration;
use Auth0\SDK\API\Management\Types\ClientProfileApplyPolicy;
use Auth0\SDK\API\Management\Types\ClientProfileApplyPolicyExternalMetadataTypeEnum;
use Auth0\SDK\API\Management\Types\ClientProfileApplyPolicyExternalMetadataCreatedByEnum;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->clientProfiles->create(
new CreateClientProfileRequestContent([
'name' => 'name',
'clientConfiguration' => new ClientProfileClientConfiguration([]),
'applyPolicy' => new ClientProfileApplyPolicy([
'externalMetadataType' => ClientProfileApplyPolicyExternalMetadataTypeEnum::Cimd->value,
'externalMetadataCreatedBy' => ClientProfileApplyPolicyExternalMetadataCreatedByEnum::Client->value,
]),
]),
);
from auth0.management import ManagementClient, ClientProfileClientConfiguration, ClientProfileApplyPolicy
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.client_profiles.create(
name="name",
client_configuration=ClientProfileClientConfiguration(),
apply_policy=ClientProfileApplyPolicy(
external_metadata_type="cimd",
external_metadata_created_by="client",
),
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.client_profiles.create(
name: "name",
client_configuration: {},
apply_policy: {
external_metadata_type: "cimd",
external_metadata_created_by: "client"
}
)
curl --request POST \
--url https://{tenantDomain}/api/v2/client-profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<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
}
},
"apply_policy": {
"external_metadata_type": "cimd",
"external_metadata_created_by": "client"
},
"description": "<string>"
}
'{
"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"
}Create a client profile
Create a client profile. At most one profile is allowed per tenant in this release; attempting to create a second returns 409 Conflict. The profile governs Dynamic CIMD clients matched by its apply_policy at runtime.
POST
https://{tenantDomain}/api/v2
/
client-profiles
TypeScript
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.clientProfiles.create({
name: "name",
client_configuration: {},
apply_policy: {
external_metadata_type: "cimd",
external_metadata_created_by: "client",
},
});
}
main();import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.clientProfiles.create({
name: "name",
client_configuration: {},
apply_policy: {
external_metadata_type: "cimd",
external_metadata_created_by: "client",
},
});
}
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.CreateClientProfileRequestContent{
Name: "name",
ClientConfiguration: &management.ClientProfileClientConfiguration{},
ApplyPolicy: &management.ClientProfileApplyPolicy{
ExternalMetadataType: management.ClientProfileApplyPolicyExternalMetadataTypeEnumCimd,
ExternalMetadataCreatedBy: management.ClientProfileApplyPolicyExternalMetadataCreatedByEnumClient,
},
}
mgmt.ClientProfiles.Create(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api post "client-profiles" --data '{
"name": "name",
"client_configuration": {},
"apply_policy": {
"external_metadata_type": "cimd",
"external_metadata_created_by": "client"
}
}'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.CreateAsync(
new CreateClientProfileRequestContent {
Name = "name",
ClientConfiguration = new ClientProfileClientConfiguration(),
ApplyPolicy = new ClientProfileApplyPolicy {
ExternalMetadataType = ClientProfileApplyPolicyExternalMetadataTypeEnum.Cimd,
ExternalMetadataCreatedBy = ClientProfileApplyPolicyExternalMetadataCreatedByEnum.Client
}
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ClientProfileApplyPolicy;
import com.auth0.client.mgmt.types.ClientProfileApplyPolicyExternalMetadataCreatedByEnum;
import com.auth0.client.mgmt.types.ClientProfileApplyPolicyExternalMetadataTypeEnum;
import com.auth0.client.mgmt.types.ClientProfileClientConfiguration;
import com.auth0.client.mgmt.types.CreateClientProfileRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.clientProfiles().create(
CreateClientProfileRequestContent
.builder()
.name("name")
.clientConfiguration(
ClientProfileClientConfiguration
.builder()
.build()
)
.applyPolicy(
ClientProfileApplyPolicy
.builder()
.externalMetadataType(ClientProfileApplyPolicyExternalMetadataTypeEnum.CIMD)
.externalMetadataCreatedBy(ClientProfileApplyPolicyExternalMetadataCreatedByEnum.CLIENT)
.build()
)
.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\CreateClientProfileRequestContent;
use Auth0\SDK\API\Management\Types\ClientProfileClientConfiguration;
use Auth0\SDK\API\Management\Types\ClientProfileApplyPolicy;
use Auth0\SDK\API\Management\Types\ClientProfileApplyPolicyExternalMetadataTypeEnum;
use Auth0\SDK\API\Management\Types\ClientProfileApplyPolicyExternalMetadataCreatedByEnum;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->clientProfiles->create(
new CreateClientProfileRequestContent([
'name' => 'name',
'clientConfiguration' => new ClientProfileClientConfiguration([]),
'applyPolicy' => new ClientProfileApplyPolicy([
'externalMetadataType' => ClientProfileApplyPolicyExternalMetadataTypeEnum::Cimd->value,
'externalMetadataCreatedBy' => ClientProfileApplyPolicyExternalMetadataCreatedByEnum::Client->value,
]),
]),
);
from auth0.management import ManagementClient, ClientProfileClientConfiguration, ClientProfileApplyPolicy
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.client_profiles.create(
name="name",
client_configuration=ClientProfileClientConfiguration(),
apply_policy=ClientProfileApplyPolicy(
external_metadata_type="cimd",
external_metadata_created_by="client",
),
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.client_profiles.create(
name: "name",
client_configuration: {},
apply_policy: {
external_metadata_type: "cimd",
external_metadata_created_by: "client"
}
)
curl --request POST \
--url https://{tenantDomain}/api/v2/client-profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<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
}
},
"apply_policy": {
"external_metadata_type": "cimd",
"external_metadata_created_by": "client"
},
"description": "<string>"
}
'{
"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
bearerAuthoAuth2ClientCredentials
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Display name of the client profile.
Required string length:
1 - 128Pattern:
^[^\u0000]*$Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.
Show child attributes
Show child attributes
Runtime matching rules that determine which clients this profile governs.
Show child attributes
Show child attributes
Optional description of the client profile.
Maximum string length:
256Pattern:
^[^\u0000]*$Response
Client profile successfully created.
Client Profile identifier.
Display name of the client profile.
Required string length:
1 - 128Pattern:
^[^\u0000]*$Runtime policy applied to matched clients. Omitted fields fall back to each client's own setting.
Show child attributes
Show child attributes
Runtime matching rules that determine which clients this profile governs.
Show child attributes
Show child attributes
Optional description of the client profile.
Maximum string length:
256Pattern:
^[^\u0000]*$Timestamp of creation.
Timestamp of last update.