{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account User Properties API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "User Properties",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Get User Properties",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/user/:userId/property",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The account ID of the user to be queried for its properties."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned properties."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of properties to return per page.\nNote, this may be restricted by fixed system limits."
              }
            ]
          },
          "docs": "Returns the properties for a user as list of property keys. For more information<br>about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Get User Property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/wiki/rest/api/user/:userId/property/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The account ID of the user to be queried for its properties."
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the user property."
              }
            ]
          },
          "docs": "Returns the property corresponding to `key` for a user. For more information<br>about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Create User Property by Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/wiki/rest/api/user/:userId/property/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian\nproducts. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the user property."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a property for a user. For more information  about user properties, see [Confluence entity properties]<br>(https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these properties stored against a user are on a Confluence site level and not space/content level.<br><br>`Note:` the number of properties which could be created per app in a tenant for each user might be<br>restricted by fixed system limits.<br>**[Permissions](https://confluence.atlassian.co"
        },
        {
          "info": {
            "name": "Atlassian Update User Property",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/wiki/rest/api/user/:userId/property/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian\nproducts. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the user property."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a property for the given user. Note, you cannot update the key of a user property, only the value.<br>For more information about user properties, see<br>[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence "
        },
        {
          "info": {
            "name": "Atlassian Delete User Property",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/wiki/rest/api/user/:userId/property/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian\nproducts. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the user property."
              }
            ]
          },
          "docs": "Deletes a property for the given user.<br>For more information about user properties, see<br>[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to access the Confluence site ('Can use' global permission)."
        },
        {
          "info": {
            "name": "Atlassian Get User Property Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/user/properties",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
              },
              {
                "name": "userKey",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              }
            ]
          },
          "docs": "Returns the keys of all properties for a user.<br><br>Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to access the property keys on any user.<br> *  Access to Jira, to access the calling user's property keys."
        },
        {
          "info": {
            "name": "Atlassian Get User Property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/user/properties/:propertyKey",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
              },
              {
                "name": "userKey",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "propertyKey",
                "value": "",
                "type": "path",
                "description": "The key of the user's property."
              }
            ]
          },
          "docs": "Returns the value of a user's property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called.<br><br>Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from any user.<br> *  Access to Jira, to get a property "
        },
        {
          "info": {
            "name": "Atlassian Set User Property",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/user/properties/:propertyKey",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
              },
              {
                "name": "userKey",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "propertyKey",
                "value": "",
                "type": "path",
                "description": "The key of the user's property. The maximum length is 255 characters."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets the value of a user's property. Use this resource to store custom data against a user.<br><br>Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on any user.<br> *  Access to Jira, to set a property on the calling user's record."
        },
        {
          "info": {
            "name": "Atlassian Delete User Property",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/user/properties/:propertyKey",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
              },
              {
                "name": "userKey",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
              },
              {
                "name": "propertyKey",
                "value": "",
                "type": "path",
                "description": "The key of the user's property."
              }
            ]
          },
          "docs": "Deletes a property from a user.<br><br>Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user.<br> *  Access to Jira, to delete a property from the calling user's record."
        }
      ]
    }
  ],
  "bundled": true
}