Delete an Attribute

Endpoint URL: {registrationDomain} /entityType.removeAttribute



Description

Removes an attribute from an entity type. Note that all the data associated with this attribute will be lost as well (that is, the attribute -- and its value -- will be removed from each user profile in the entity type).

Refer to the Registration Error Codes section for details on error codes.


Respects the API Client Allow List: Yes


API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

owner
access_issuer
direct_access
direct_read_access
login_client
Yes
No
No
No
No


Authentication

This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String


Base URL

The base URL for this endpoint is your Identity Cloud Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:

Examples

Example Request

This command removes the fullName attribute from the user entity type. Note that there is no way to “undo” the removal of a schema attribute.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg"\
  --data-urlencode type_name=user \
  --data-urlencode attribute_name=fullName \
  https://my-app.janraincapture.com/entityType.removeAttribute
       

      Running this command in Postman


Example Response


{
  "schema": {
    "attr_defs": [
      {
        "description": "simple identifier for this entity",
        "name": "id",
        "type": "id"
      },
      {
        "description": "globally unique identifier for this entity",
        "name": "uuid",
        "type": "uuid"
      },
      {
        "description": "when this entity was created",
        "name": "created",
        "type": "dateTime"
      },
      {
        "description": "when this entity was last updated",
        "name": "lastUpdated",
        "type": "dateTime"
      },
      {
        "case-sensitive": false,
        "length": 1000,
        "name": "Description",
        "type": "string"
      },
      {
        "case-sensitive": false,
        "length": null,
        "name": "Name",
        "type": "string"
      }
    ],
    "name": "user"
  },
  "stat": "ok"
}
       


Query Parameters

ParameterTypeRequiredDescription
type_namestringYesName of the entityType.
 
attribute_namestringYesName of the attribute to be deleted.