> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a client profile
> Retrieve a single client profile by its identifier. Returns 404 if no profile with the given ID exists for the tenant.
#### Scopes
Scopes define permissions and access levels for API requests and authentication tokens.
[](#scopes-scopes)
## OpenAPI
````yaml docs/oas/management/v2/management-api-oas.json GET /client-profiles/{id}
openapi: 3.1.0
info:
title: Auth0 Management API
description: Auth0 Management API v2.
termsOfService: https://auth0.com/web-terms/
contact:
name: Auth0 Support
url: https://support.auth0.com
version: '2.0'
servers:
- url: https://{tenantDomain}/api/v2
variables:
tenantDomain:
default: '{TENANT}.auth0.com'
description: Auth0 Tenant Domain
security:
- bearerAuth: []
externalDocs:
description: Auth0 Management API Documentation
url: https://auth0.com/docs/api/management/v2/
paths:
/client-profiles/{id}:
get:
tags:
- client-profiles
summary: Get a client profile
description: >-
Retrieve a single client profile by its identifier. Returns
404 if no profile with the given ID exists for the tenant.
operationId: get_client_profile
parameters:
- $ref: '#/components/parameters/ClientProfileIdParameter'
responses:
'200':
$ref: '#/components/responses/GetClientProfile'
'400':
description: >-
Invalid request query string. The message will vary depending on the
cause.
'401':
description: Invalid token.
'403':
description: 'Insufficient scope; expected any of: read:client_profiles'
'404':
description: Client profile not found.
'429':
description: >-
Too many requests. Check the X-RateLimit-Limit,
X-RateLimit-Remaining and X-RateLimit-Reset headers.
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:client_profiles
x-codeSamples:
- lang: typescript
label: Get a client profile
source: |
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "",
});
await client.clientProfiles.get("id");
}
main();
- lang: javascript
label: Get a client profile
source: |
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "",
});
await client.clientProfiles.get("id");
}
main();
- lang: go
label: Get a client profile
source: |
package example
import (
context "context"
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(
"",
),
)
if err != nil {
return
}
mgmt.ClientProfiles.Get(
context.TODO(),
"id",
)
}
- lang: zsh
label: Get a client profile
source: |-
# Ensure you're logged in: auth0 login
auth0 api get "client-profiles/id"
- lang: csharp
label: Get a client profile
source: |
using Auth0.ManagementApi;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.ClientProfiles.GetAsync(
"id"
);
}
}
- lang: java
label: Get a client profile
source: |-
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("")
.build();
client.clientProfiles().get("id");
}
}
- lang: php
label: Get a client profile
source: |
',
));
$client->clientProfiles->get(
'id',
);
- lang: python
label: Get a client profile
source: |
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="",
)
client.client_profiles.get(
id="id",
)
- lang: ruby
label: Get a client profile
source: >
require "auth0"
client = Auth0::Management.new(token: "", base_url:
"https://{YOUR_DOMAIN}/api/v2")
client.client_profiles.get(id: "id")
components:
parameters:
ClientProfileIdParameter:
name: id
in: path
description: ID of the client profile.
required: true
schema:
$ref: '#/components/schemas/ClientProfileId'
responses:
GetClientProfile:
description: Record for existing client profile.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientProfile'
schemas:
ClientProfileId:
type: string
description: Client Profile identifier.
format: client-profile-id
ClientProfile:
type: object
additionalProperties: false
required:
- id
- name
- client_configuration
- apply_policy
properties:
id:
$ref: '#/components/schemas/ClientProfileId'
name:
$ref: '#/components/schemas/ClientProfileName'
description:
$ref: '#/components/schemas/ClientProfileDescription'
client_configuration:
$ref: '#/components/schemas/ClientProfileClientConfiguration'
apply_policy:
$ref: '#/components/schemas/ClientProfileApplyPolicy'
created_at:
type: string
description: Timestamp of creation.
format: date-time
updated_at:
type: string
description: Timestamp of last update.
format: date-time
ClientProfileName:
type: string
description: Display name of the client profile.
minLength: 1
maxLength: 128
pattern: ^[^\u0000]*$
ClientProfileDescription:
type:
- string
- 'null'
description: Optional description of the client profile.
maxLength: 256
pattern: ^[^\u0000]*$
ClientProfileClientConfiguration:
type: object
description: >-
Runtime policy applied to matched clients. Omitted fields fall back to
each client's own setting.
additionalProperties: false
properties:
refresh_token:
$ref: '#/components/schemas/ClientProfileClientConfigurationRefreshToken'
organization_usage:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationOrganizationUsage
organization_require_behavior:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationOrganizationRequireBehavior
organization_discovery_methods:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationOrganizationDiscoveryMethods
require_proof_of_possession:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationRequireProofOfPossession
ClientProfileApplyPolicy:
type: object
description: >-
Runtime matching rules that determine which clients this profile
governs.
additionalProperties: false
required:
- external_metadata_type
- external_metadata_created_by
properties:
external_metadata_type:
$ref: >-
#/components/schemas/ClientProfileApplyPolicyExternalMetadataTypeEnum
external_metadata_created_by:
$ref: >-
#/components/schemas/ClientProfileApplyPolicyExternalMetadataCreatedByEnum
ClientProfileClientConfigurationRefreshToken:
type: object
description: >-
Refresh token settings. Omit any sub-field to use the client's own
value.
additionalProperties: false
properties:
token_lifetime:
$ref: '#/components/schemas/ClientProfileRefreshTokenTokenLifetime'
idle_token_lifetime:
$ref: '#/components/schemas/ClientProfileRefreshTokenIdleTokenLifetime'
leeway:
$ref: '#/components/schemas/ClientProfileRefreshTokenLeeway'
ClientProfileClientConfigurationOrganizationUsage:
type: object
description: Default organization usage applied to matched clients.
additionalProperties: false
properties:
default_value:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationOrganizationUsageEnum
ClientProfileClientConfigurationOrganizationRequireBehavior:
type: object
description: Default organization prompt behavior applied to matched clients.
additionalProperties: false
properties:
default_value:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationOrganizationRequireBehaviorEnum
ClientProfileClientConfigurationOrganizationDiscoveryMethods:
type: object
description: Default organization discovery methods applied to matched clients.
additionalProperties: false
properties:
default_value:
type: array
items:
$ref: >-
#/components/schemas/ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum
ClientProfileClientConfigurationRequireProofOfPossession:
type: object
description: Whether matched clients default to requiring proof of possession.
additionalProperties: false
properties:
default_value:
type: boolean
ClientProfileApplyPolicyExternalMetadataTypeEnum:
type: string
description: >-
The client's type of external metadata to match. The value
cimd identifies clients registered via a Client ID Metadata
Document.
enum:
- cimd
ClientProfileApplyPolicyExternalMetadataCreatedByEnum:
type: string
description: >-
The external metadata client's creator to match. The value
client indicates the client was registered dynamically.
enum:
- client
ClientProfileRefreshTokenTokenLifetime:
type: object
description: Default refresh token lifetime, in seconds, applied to matched clients.
additionalProperties: false
properties:
default_value:
type: integer
minimum: 1
maximum: 31557600
ClientProfileRefreshTokenIdleTokenLifetime:
type: object
description: >-
Default idle refresh token lifetime, in seconds, applied to matched
clients.
additionalProperties: false
properties:
default_value:
type: integer
minimum: 1
maximum: 31557600
ClientProfileRefreshTokenLeeway:
type: object
description: >-
Default refresh token rotation leeway, in seconds, applied to matched
clients.
additionalProperties: false
properties:
default_value:
type: integer
minimum: 0
ClientProfileClientConfigurationOrganizationUsageEnum:
type: string
description: How matched clients handle organizations.
enum:
- deny
- allow
- require
ClientProfileClientConfigurationOrganizationRequireBehaviorEnum:
type: string
description: When an organization is required, how matched clients prompt for it.
enum:
- no_prompt
- pre_login_prompt
- post_login_prompt
ClientProfileClientConfigurationOrganizationDiscoveryMethodEnum:
type: string
description: A method used to discover a user's organization.
enum:
- email
- organization_name
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: jwt
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: /oauth/token/
x-form-parameters:
audience: /api/v2/
scopes:
create:actions: Create Actions
read:actions: Read Actions
update:actions: Update Actions
delete:actions: Delete Actions
create:agents: Create Agents
read:agents: Read Agents
update:agents: Update Agents
delete:agents: Delete Agents
read:anomaly_blocks: Read Anomaly Blocks
delete:anomaly_blocks: Delete Anomaly Blocks
read:attack_protection: Read Attack Protection
update:attack_protection: Update Attack Protection
create:authentication_methods: Create Authentication Methods
read:authentication_methods: Read Authentication Methods
update:authentication_methods: Update Authentication Methods
delete:authentication_methods: Delete Authentication Methods
read:branding: Read Branding
update:branding: Update Branding
delete:branding: Delete Branding
create:client_credentials: Create Client Credentials
read:client_credentials: Read Client Credentials
update:client_credentials: Update Client Credentials
delete:client_credentials: Delete Client Credentials
create:client_grants: Create Client Grants
read:client_grants: Read Client Grants
update:client_grants: Update Client Grants
delete:client_grants: Delete Client Grants
read:client_keys: Read Client Keys
update:client_keys: Update Client Keys
read:client_summary: Read Client Summary
update:client_token_vault_privileged_access: Update Client Token Vault Privileged Access
create:clients: Create Clients
read:clients: Read Clients
update:clients: Update Clients
delete:clients: Delete Clients
create:connection_profiles: Create Connection Profiles
read:connection_profiles: Read Connection Profiles
update:connection_profiles: Update Connection Profiles
delete:connection_profiles: Delete Connection Profiles
create:connections: Create Connections
read:connections: Read Connections
update:connections: Update Connections
delete:connections: Delete Connections
create:connections_keys: Create Connections Keys
read:connections_keys: Read Connections Keys
update:connections_keys: Update Connections Keys
read:current_user: Read Current User
delete:current_user: Delete Current User
create:current_user_device_credentials: Create Current User Device Credentials
delete:current_user_device_credentials: Delete Current User Device Credentials
update:current_user_identities: Update Current User Identities
update:current_user_metadata: Update Current User Metadata
create:custom_domains: Create Custom Domains
read:custom_domains: Read Custom Domains
update:custom_domains: Update Custom Domains
delete:custom_domains: Delete Custom Domains
create:custom_signing_keys: Create Custom Signing Keys
read:custom_signing_keys: Read Custom Signing Keys
update:custom_signing_keys: Update Custom Signing Keys
delete:custom_signing_keys: Delete Custom Signing Keys
read:device_credentials: Read Device Credentials
delete:device_credentials: Delete Device Credentials
create:directory_provisionings: Create Directory Provisionings
read:directory_provisionings: Read Directory Provisionings
update:directory_provisionings: Update Directory Provisionings
delete:directory_provisionings: Delete Directory Provisionings
create:email_provider: Create Email Provider
read:email_provider: Read Email Provider
update:email_provider: Update Email Provider
delete:email_provider: Delete Email Provider
create:email_templates: Create Email Templates
read:email_templates: Read Email Templates
update:email_templates: Update Email Templates
create:encryption_keys: Create Encryption Keys
read:encryption_keys: Read Encryption Keys
update:encryption_keys: Update Encryption Keys
delete:encryption_keys: Delete Encryption Keys
read:event_deliveries: Read Event Deliveries
update:event_deliveries: Update Event Deliveries
create:event_streams: Create Event Streams
read:event_streams: Read Event Streams
update:event_streams: Update Event Streams
delete:event_streams: Delete Event Streams
read:events: Read Events
create:experimentation: Create Experimentation
read:experimentation: Read Experimentation
update:experimentation: Update Experimentation
delete:experimentation: Delete Experimentation
create:flows: Create Flows
read:flows: Read Flows
update:flows: Update Flows
delete:flows: Delete Flows
read:flows_executions: Read Flows Executions
delete:flows_executions: Delete Flows Executions
create:flows_vault_connections: Create Flows Vault Connections
read:flows_vault_connections: Read Flows Vault Connections
update:flows_vault_connections: Update Flows Vault Connections
delete:flows_vault_connections: Delete Flows Vault Connections
create:forms: Create Forms
read:forms: Read Forms
update:forms: Update Forms
delete:forms: Delete Forms
read:grants: Read Grants
delete:grants: Delete Grants
read:group_members: Read Group Members
create:group_roles: Create Group Roles
read:group_roles: Read Group Roles
delete:group_roles: Delete Group Roles
read:groups: Read Groups
delete:groups: Delete Groups
create:guardian_enrollment_tickets: Create Guardian Enrollment Tickets
read:guardian_enrollments: Read Guardian Enrollments
delete:guardian_enrollments: Delete Guardian Enrollments
read:guardian_factors: Read Guardian Factors
update:guardian_factors: Update Guardian Factors
create:hooks: Create Hooks
read:hooks: Read Hooks
update:hooks: Update Hooks
delete:hooks: Delete Hooks
create:log_streams: Create Log Streams
read:log_streams: Read Log Streams
update:log_streams: Update Log Streams
delete:log_streams: Delete Log Streams
read:logs: Read Logs
read:logs_users: Read Logs Users
read:mfa_policies: Read Mfa Policies
update:mfa_policies: Update Mfa Policies
create:network_acls: Create Network Acls
read:network_acls: Read Network Acls
update:network_acls: Update Network Acls
delete:network_acls: Delete Network Acls
create:organization_client_grants: Create Organization Client Grants
read:organization_client_grants: Read Organization Client Grants
delete:organization_client_grants: Delete Organization Client Grants
create:organization_connections: Create Organization Connections
read:organization_connections: Read Organization Connections
update:organization_connections: Update Organization Connections
delete:organization_connections: Delete Organization Connections
create:organization_discovery_domains: Create Organization Discovery Domains
read:organization_discovery_domains: Read Organization Discovery Domains
update:organization_discovery_domains: Update Organization Discovery Domains
delete:organization_discovery_domains: Delete Organization Discovery Domains
create:organization_group_roles: Create Organization Group Roles
read:organization_group_roles: Read Organization Group Roles
delete:organization_group_roles: Delete Organization Group Roles
read:organization_groups: Read Organization Groups
create:organization_invitations: Create Organization Invitations
read:organization_invitations: Read Organization Invitations
delete:organization_invitations: Delete Organization Invitations
read:organization_member_effective_roles: Read Organization Member Effective Roles
read:organization_member_role_source_groups: Read Organization Member Role Source Groups
create:organization_member_roles: Create Organization Member Roles
read:organization_member_roles: Read Organization Member Roles
delete:organization_member_roles: Delete Organization Member Roles
create:organization_members: Create Organization Members
read:organization_members: Read Organization Members
delete:organization_members: Delete Organization Members
create:organizations: Create Organizations
read:organizations: Read Organizations
update:organizations: Update Organizations
delete:organizations: Delete Organizations
read:organizations_summary: Read Organizations Summary
create:phone_providers: Create Phone Providers
read:phone_providers: Read Phone Providers
update:phone_providers: Update Phone Providers
delete:phone_providers: Delete Phone Providers
create:phone_templates: Create Phone Templates
read:phone_templates: Read Phone Templates
update:phone_templates: Update Phone Templates
delete:phone_templates: Delete Phone Templates
read:prompts: Read Prompts
update:prompts: Update Prompts
create:rate_limit_policies: Create Rate Limit Policies
read:rate_limit_policies: Read Rate Limit Policies
update:rate_limit_policies: Update Rate Limit Policies
delete:rate_limit_policies: Delete Rate Limit Policies
read:refresh_tokens: Read Refresh Tokens
update:refresh_tokens: Update Refresh Tokens
delete:refresh_tokens: Delete Refresh Tokens
create:resource_servers: Create Resource Servers
read:resource_servers: Read Resource Servers
update:resource_servers: Update Resource Servers
delete:resource_servers: Delete Resource Servers
create:role_members: Create Role Members
read:role_members: Read Role Members
delete:role_members: Delete Role Members
create:roles: Create Roles
read:roles: Read Roles
update:roles: Update Roles
delete:roles: Delete Roles
create:rules: Create Rules
read:rules: Read Rules
update:rules: Update Rules
delete:rules: Delete Rules
read:rules_configs: Read Rules Configs
update:rules_configs: Update Rules Configs
delete:rules_configs: Delete Rules Configs
create:scim_config: Create Scim Config
read:scim_config: Read Scim Config
update:scim_config: Update Scim Config
delete:scim_config: Delete Scim Config
create:scim_token: Create Scim Token
read:scim_token: Read Scim Token
delete:scim_token: Delete Scim Token
read:self_service_profile_custom_texts: Read Self Service Profile Custom Texts
update:self_service_profile_custom_texts: Update Self Service Profile Custom Texts
create:self_service_profiles: Create Self Service Profiles
read:self_service_profiles: Read Self Service Profiles
update:self_service_profiles: Update Self Service Profiles
delete:self_service_profiles: Delete Self Service Profiles
read:sessions: Read Sessions
update:sessions: Update Sessions
delete:sessions: Delete Sessions
create:signing_keys: Create Signing Keys
read:signing_keys: Read Signing Keys
update:signing_keys: Update Signing Keys
create:sso_access_tickets: Create Sso Access Tickets
delete:sso_access_tickets: Delete Sso Access Tickets
read:stats: Read Stats
read:tenant_settings: Read Tenant Settings
update:tenant_settings: Update Tenant Settings
create:token_exchange_profiles: Create Token Exchange Profiles
read:token_exchange_profiles: Read Token Exchange Profiles
update:token_exchange_profiles: Update Token Exchange Profiles
delete:token_exchange_profiles: Delete Token Exchange Profiles
create:user_attribute_profiles: Create User Attribute Profiles
read:user_attribute_profiles: Read User Attribute Profiles
update:user_attribute_profiles: Update User Attribute Profiles
delete:user_attribute_profiles: Delete User Attribute Profiles
read:user_effective_permissions: Read User Effective Permissions
read:user_effective_roles: Read User Effective Roles
read:user_idp_tokens: Read User Idp Tokens
read:user_permission_source_roles: Read User Permission Source Roles
read:user_role_source_groups: Read User Role Source Groups
create:user_tickets: Create User Tickets
create:users: Create Users
read:users: Read Users
update:users: Update Users
delete:users: Delete Users
update:users_app_metadata: Update Users App Metadata
create:vdcs_templates: Create Vdcs Templates
read:vdcs_templates: Read Vdcs Templates
update:vdcs_templates: Update Vdcs Templates
delete:vdcs_templates: Delete Vdcs Templates
create:client_profiles: Create Client Profiles
read:client_profiles: Read Client Profiles
update:client_profiles: Update Client Profiles
delete:client_profiles: Delete Client Profiles
create:organization_clients: Create Organization Client Associations
read:organization_clients: Read Organization Client Associations
update:organization_clients: Update Organization Client Associations
delete:organization_clients: Delete Organization Client Associations
create:network_acl_keys: Create Network ACL Keys
read:network_acl_keys: Read Network ACL Keys
delete:network_acl_keys: Delete Network ACL Keys
````