---
title: User
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-user
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-user.html
section_ids:
  sec-amster-entity-user-realm-ops: Realm Operations
  sec-amster-entity-user-realm-ops-create: create
  sec-amster-entity-user-realm-ops-delete: delete
  sec-amster-entity-user-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-user-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-user-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-user-realm-ops-read: read
  sec-amster-entity-user-realm-ops-update: update
  sec-amster-entity-user-global-ops: Global Operations
  sec-amster-entity-user-global-ops-getalltypes: getAllTypes
  sec-amster-entity-user-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-user-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-user-global-ops-read: read
  sec-amster-entity-user-global-ops-update: update
---

# User

## Realm Operations

Resource path:

```
/realm-config/services/user
```

Resource version: `0.0`

### create

**Usage**

```
am> create User --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "dynamic" : {
        "properties" : {
          "preferredTimezone" : {
            "title" : "User Preferred Timezone",
            "description" : "Time zone for accessing OpenAM console.",
            "propertyOrder" : 100,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "adminDNStartingView" : {
            "title" : "Administrator DN Starting View",
            "description" : "Specifies the DN for the initial screen when the OpenAM administrator successfully logs in to the OpenAM console.",
            "propertyOrder" : 200,
            "required" : false,
            "type" : "string",
            "exampleValue" : ""
          },
          "defaultUserStatus" : {
            "title" : "Default User Status",
            "description" : "Inactive users cannot authenticate, though OpenAM stores their profiles.",
            "propertyOrder" : 300,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Dynamic Attributes"
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete User --realm Realm
```

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action User --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action User --realm Realm --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action User --realm Realm --actionName nextdescendents
```

### read

**Usage**

```
am> read User --realm Realm
```

### update

**Usage**

```
am> update User --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "dynamic" : {
        "properties" : {
          "preferredTimezone" : {
            "title" : "User Preferred Timezone",
            "description" : "Time zone for accessing OpenAM console.",
            "propertyOrder" : 100,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "adminDNStartingView" : {
            "title" : "Administrator DN Starting View",
            "description" : "Specifies the DN for the initial screen when the OpenAM administrator successfully logs in to the OpenAM console.",
            "propertyOrder" : 200,
            "required" : false,
            "type" : "string",
            "exampleValue" : ""
          },
          "defaultUserStatus" : {
            "title" : "Default User Status",
            "description" : "Inactive users cannot authenticate, though OpenAM stores their profiles.",
            "propertyOrder" : 300,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Dynamic Attributes"
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/services/user
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action User --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action User --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action User --global --actionName nextdescendents
```

### read

**Usage**

```
am> read User --global
```

### update

**Usage**

```
am> update User --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "dynamic" : {
        "properties" : {
          "defaultUserStatus" : {
            "title" : "Default User Status",
            "description" : "Inactive users cannot authenticate, though OpenAM stores their profiles.",
            "propertyOrder" : 300,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "adminDNStartingView" : {
            "title" : "Administrator DN Starting View",
            "description" : "Specifies the DN for the initial screen when the OpenAM administrator successfully logs in to the OpenAM console.",
            "propertyOrder" : 200,
            "required" : false,
            "type" : "string",
            "exampleValue" : ""
          },
          "preferredTimezone" : {
            "title" : "User Preferred Timezone",
            "description" : "Time zone for accessing OpenAM console.",
            "propertyOrder" : 100,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Dynamic Attributes"
      }
    }
  }
  ```