Assigns Policies to a User - Only SR

Assign policy.

Assign policy.

POST/api/v1/permissions/users/{username}/policies/assign

Authorization

bearer

Path parameters

username*string

User Identifier

Example: "username"

Body

application/json

Options.

policyIds*array of string

assign*boolean

Example: true

Response

200401403500

Assigned policy.

Body

application/json

id*string

Example: "000000000000000000000001"

uuid*string

Example: "00000000-0000-0000-0000-000000000000"

name*string

Example: "Policy name"

description*string

Example: "Description"

topicDescription*string

Example: "Description"

policyTag*string

Example: "Tag"

status*enum

Example: "DRAFT"

DRY-RUNDRAFTPUBLISH_ERRORPUBLISHDISCONTINUED

creator*string

Example: "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001"

owner*string

Example: "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001"

topicId*string

Example: "0.0.1"

messageId*string

Example: "0000000000.000000001"

codeVersion*string

Example: "1.0.0"

createDate*string

Example: "1900-01-01T00:00:00.000Z"

version*string

Example: "1.0.0"

config*object

userRole*string

Example: "Installer"

userRoles*array of string

userGroup*object

userGroups*array of object

policyRoles*array of string

policyNavigation*array of object

policyTopics*array of object

policyTokens*array of object

policyGroups*array of object

categories*array of string

projectSchema*string

Example: "00000000-0000-0000-0000-000000000000"

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/permissions/users/{username}/policies/assign', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "policyIds": [
        "000000000000000000000001"
      ],
      "assign": true
    }),
});
const data = await response.json();

Response

200500

{
  "id": "000000000000000000000001",
  "uuid": "00000000-0000-0000-0000-000000000000",
  "name": "Policy name",
  "description": "Description",
  "topicDescription": "Description",
  "policyTag": "Tag",
  "status": "DRAFT",
  "creator": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "topicId": "0.0.1",
  "messageId": "0000000000.000000001",
  "codeVersion": "1.0.0",
  "createDate": "1900-01-01T00:00:00.000Z",
  "version": "1.0.0",
  "userRole": "Installer",
  "userRoles": [
    "Installer"
  ],
  "userGroup": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "role": "Installer",
    "groupLabel": "Label",
    "groupName": "Name",
    "active": true
  },
  "userGroups": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    }
  ],
  "policyRoles": [
    "Registrant"
  ],
  "policyNavigation": [
    {
      "role": "Registrant",
      "steps": [
        {
          "block": "Block tag",
          "level": 1,
          "name": "Step name"
        }
      ]
    }
  ],
  "policyTopics": [
    {
      "name": "Project",
      "description": "<p>Project</p>",
      "memoObj": "topic",
      "static": false,
      "type": "any",
      "__$markdownParsed": true
    }
  ],
  "policyTokens": [
    {
      "tokenName": "Token name",
      "tokenSymbol": "Token symbol",
      "tokenType": "non-fungible",
      "decimals": "",
      "changeSupply": true,
      "enableAdmin": true,
      "enableFreeze": true,
      "enableKYC": true,
      "enableWipe": true,
      "templateTokenTag": "token_template_0"
    }
  ],
  "policyGroups": [
    {
      "name": "Group name",
      "creator": "Registrant",
      "groupAccessType": "Private",
      "groupRelationshipType": "Multiple",
      "members": [
        "Registrant"
      ]
    }
  ],
  "categories": [
    "text"
  ],
  "projectSchema": "00000000-0000-0000-0000-000000000000"
}