---
title: Realms
description: The endpoint for Realm operations
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-realms
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-realms.html
section_ids:
  sec-amster-entity-realms-global-ops: Global Operations
  sec-amster-entity-realms-global-ops-create: create
  sec-amster-entity-realms-global-ops-delete: delete
  sec-amster-entity-realms-global-ops-query: query
  sec-amster-entity-realms-global-ops-read: read
  sec-amster-entity-realms-global-ops-update: update
---

# Realms

## Global Operations

The endpoint for Realm operations

Resource path:

```
/global-config/realms
```

Resource version: `1.0`

### create

Create a Realm

**Usage**

```
am> create Realms --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "description" : "Represents a Realm Resource",
    "type" : "object",
    "title" : "Realm",
    "properties" : {
      "name" : {
        "type" : "string",
        "title" : "Name",
        "description" : "The name of the Realm"
      },
      "active" : {
        "type" : "boolean",
        "title" : "Active",
        "description" : "True if the Realm is active"
      },
      "parentPath" : {
        "type" : "string",
        "title" : "Parent",
        "description" : "The path of the Realm's parent Realm"
      },
      "aliases" : {
        "type" : "array",
        "title" : "Aliases",
        "description" : "Aliases which can be used reference to the Realm",
        "items" : {
          "type" : "string"
        }
      }
    },
    "required" : [ "name", "active", "parentPath", "aliases" ]
  }
  ```

### delete

Delete a Realm

**Usage**

```
am> delete Realms --global --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### query

**Usage**

```
am> query Realms --global --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

Read a Realm

**Usage**

```
am> read Realms --global --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

Update a Realm

**Usage**

```
am> update Realms --global --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

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

  ```json
  {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "description" : "Represents a Realm Resource",
    "type" : "object",
    "title" : "Realm",
    "properties" : {
      "name" : {
        "type" : "string",
        "title" : "Name",
        "description" : "The name of the Realm"
      },
      "active" : {
        "type" : "boolean",
        "title" : "Active",
        "description" : "True if the Realm is active"
      },
      "parentPath" : {
        "type" : "string",
        "title" : "Parent",
        "description" : "The path of the Realm's parent Realm"
      },
      "aliases" : {
        "type" : "array",
        "title" : "Aliases",
        "description" : "Aliases which can be used reference to the Realm",
        "items" : {
          "type" : "string"
        }
      }
    },
    "required" : [ "name", "active", "parentPath", "aliases" ]
  }
  ```