Get tenant attribute | API Reference

GET

/v1/mgmt/tenant/attribute

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Query Parameters

name?string

Get a single tenant custom attribute definition by machine name, using a valid management key.

curl -X GET "https://api.descope.com/v1/mgmt/tenant/attribute"

curl -X GET "https://api.descope.com/v1/mgmt/tenant/attribute"

ResponseOK

{
  "name": "string",
  "displayName": "string",
  "type": "string",
  "options": null,
  "viewPermissions": null,
  "editPermissions": null
}

{  "name": "string",  "displayName": "string",  "type": "string",  "options": null,  "viewPermissions": null,  "editPermissions": null}

TypeScript

/**
 * Custom attribute definitions (Terraform: descope_user_attribute / descope_tenant_attribute / descope_access_key_attribute).
 *  Shared across all three entity types; the service converts type<->int32 and options<->{value,label} pairs. editPermissions
 *  is rejected for tenant attributes (view-only).
 */
export interface Response {
name?: string
displayName?: string
type?: string
/**
 * JSON arrays of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service
 */
options?: {
[k: string]: unknown
}
/**
 * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
 */
viewPermissions?: {
[k: string]: unknown
}
/**
 * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
 */
editPermissions?: {
[k: string]: unknown
}
}

/** * Custom attribute definitions (Terraform: descope_user_attribute / descope_tenant_attribute / descope_access_key_attribute). *  Shared across all three entity types; the service converts type<->int32 and options<->{value,label} pairs. editPermissions *  is rejected for tenant attributes (view-only). */export interface Response {name?: stringdisplayName?: stringtype?: string/** * JSON arrays of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service */options?: {[k: string]: unknown}/** * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. */viewPermissions?: {[k: string]: unknown}/** * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. */editPermissions?: {[k: string]: unknown}}

Was this helpful?