---
title: UmaPolicies
description: Provides create, delete and query operations for UMA Policies
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-umapolicies
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-umapolicies.html
section_ids:
  sec-amster-entity-umapolicies-realm-ops: Realm Operations
  sec-amster-entity-umapolicies-realm-ops-create: create
  sec-amster-entity-umapolicies-realm-ops-delete: delete
  sec-amster-entity-umapolicies-realm-ops-query: query
  sec-amster-entity-umapolicies-realm-ops-read: read
  sec-amster-entity-umapolicies-realm-ops-update: update
---

# UmaPolicies

## Realm Operations

Provides create, delete and query operations for UMA Policies

Resource path:

```
/users/{user}/uma/policies
```

Resource version: `1.0`

### create

Creates an UMA Policy

**Usage**

```
am> create UmaPolicies --realm Realm --id id --body body --user user
```

**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" : "A policy defining who can access a particular resource set",
    "type" : "object",
    "title" : "UMA Policy",
    "properties" : {
      "policyId" : {
        "type" : "string",
        "title" : "Policy ID",
        "description" : "The ID must correspond with an existing resource set ID"
      },
      "permissions" : {
        "type" : "array",
        "title" : "Permissions",
        "description" : "A list of subjects and the scopes they are allowed access to",
        "items" : {
          "type" : "object",
          "properties" : {
            "subject" : {
              "type" : "string",
              "title" : "Subject",
              "description" : "The username of the subject"
            },
            "scopes" : {
              "type" : "array",
              "title" : "Scopes",
              "description" : "The scopes that the user is allowed access to",
              "items" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }
  }
  ```

* *\--user*

  Provides create, delete and query operations for UMA Policies

### delete

Deletes an UMA Policy

**Usage**

```
am> delete UmaPolicies --realm Realm --id id --user user
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--user*

  Provides create, delete and query operations for UMA Policies

### query

Queries an UMA Policy

**Usage**

```
am> query UmaPolicies --realm Realm --filter filter --user user
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all. Fields that can be queried: \[\*]

* *\--user*

  Provides create, delete and query operations for UMA Policies

### read

Reads an UMA Policy

**Usage**

```
am> read UmaPolicies --realm Realm --id id --user user
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--user*

  Provides create, delete and query operations for UMA Policies

### update

Updates an UMA Policy

**Usage**

```
am> update UmaPolicies --realm Realm --id id --body body --user user
```

**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" : "A policy defining who can access a particular resource set",
    "type" : "object",
    "title" : "UMA Policy",
    "properties" : {
      "policyId" : {
        "type" : "string",
        "title" : "Policy ID",
        "description" : "The ID must correspond with an existing resource set ID"
      },
      "permissions" : {
        "type" : "array",
        "title" : "Permissions",
        "description" : "A list of subjects and the scopes they are allowed access to",
        "items" : {
          "type" : "object",
          "properties" : {
            "subject" : {
              "type" : "string",
              "title" : "Subject",
              "description" : "The username of the subject"
            },
            "scopes" : {
              "type" : "array",
              "title" : "Scopes",
              "description" : "The scopes that the user is allowed access to",
              "items" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }
  }
  ```

* *\--user*

  Provides create, delete and query operations for UMA Policies