{
  "opencollection": "1.0.0",
  "info": {
    "name": "Flowable REST Access Tokens Users API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/identity/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Only return group with the given id"
              },
              {
                "name": "firstName",
                "value": "",
                "type": "query",
                "description": "Only return users with the given firstname"
              },
              {
                "name": "lastName",
                "value": "",
                "type": "query",
                "description": "Only return users with the given lastname"
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "Only return users with the given displayName"
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Only return users with the given email"
              },
              {
                "name": "firstNameLike",
                "value": "",
                "type": "query",
                "description": "Only return userswith a firstname like the given value. Use % as wildcard-character."
              },
              {
                "name": "lastNameLike",
                "value": "",
                "type": "query",
                "description": "Only return users with a lastname like the given value. Use % as wildcard-character."
              },
              {
                "name": "displayNameLike",
                "value": "",
                "type": "query",
                "description": "Only return users with a displayName like the given value. Use % as wildcard-character."
              },
              {
                "name": "emailLike",
                "value": "",
                "type": "query",
                "description": "Only return users with an email like the given value. Use % as wildcard-character."
              },
              {
                "name": "memberOfGroup",
                "value": "",
                "type": "query",
                "description": "Only return users which are a member of the given group."
              },
              {
                "name": "tenantId",
                "value": "",
                "type": "query",
                "description": "Only return users which are a members of the given tenant."
              },
              {
                "name": "potentialStarter",
                "value": "",
                "type": "query",
                "description": "Only return users  which members are potential starters for a process-definition with the given id."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Property to sort on, to be used together with the order."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sort order, either 'asc' or 'desc'. Defaults to 'asc'."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Index of the first row to fetch. Defaults to 0."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of rows to fetch, starting from start. Defaults to 10."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List users"
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/identity/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a user"
        },
        {
          "info": {
            "name": "Get a single user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/identity/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a single user"
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/identity/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "All request values are optional. For example, you can only include the firstName attribute in the request body JSON-object, only updating the firstName of the user, leaving all other fields unaffected. When an attribute is explicitly included and is set to null, the user-value will be updated to null. Example: {\"firstName\" : null} will clear the firstName of the user)."
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/identity/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a user"
        },
        {
          "info": {
            "name": "List user’s info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/identity/users/:userId/info",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List user’s info"
        },
        {
          "info": {
            "name": "Create a new user’s info entry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/identity/users/:userId/info",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a new user’s info entry"
        },
        {
          "info": {
            "name": "Get a user’s info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/identity/users/:userId/info/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "key",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a user’s info"
        },
        {
          "info": {
            "name": "Update a user’s info",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/identity/users/:userId/info/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "key",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a user’s info"
        },
        {
          "info": {
            "name": "Delete a user’s info",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/identity/users/:userId/info/:key",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "key",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a user’s info"
        },
        {
          "info": {
            "name": "Get a user’s picture",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/identity/users/:userId/picture",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The response body contains the raw picture data, representing the user’s picture. The Content-type of the response corresponds to the mimeType that was set when creating the picture."
        },
        {
          "info": {
            "name": "Updating a user’s picture",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/identity/users/:userId/picture",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The request should be of type multipart/form-data. There should be a single file-part included with the binary value of the picture. On top of that, the following additional form-fields can be present:\n\nmimeType: Optional mime-type for the uploaded picture. If omitted, the default of image/jpeg is used as a mime-type for the picture."
        },
        {
          "info": {
            "name": "Query users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/query/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Query users"
        },
        {
          "info": {
            "name": "Search a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/search/query-users",
            "params": [
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "displayName filter to return results for."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "email filter to return results for."
              },
              {
                "name": "firstName",
                "value": "",
                "type": "query",
                "description": "firstName filter to return results for."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id filter to return results for."
              },
              {
                "name": "lastName",
                "value": "",
                "type": "query",
                "description": "lastName filter to return results for."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "From the paginate request.  The sort order, either 'asc' or 'desc'. Defaults to 'asc'."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "From the paginate request. Number of rows to fetch, starting from start. Defaults to 10."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Property to sort the results on"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "From the paginate request. Index of the first row to fetch. Defaults to 0."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "state filter to return results for."
              },
              {
                "name": "tenantId",
                "value": "",
                "type": "query",
                "description": "tenantId filter to return results for."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "type filter to return results for."
              },
              {
                "name": "userDefinitionKey",
                "value": "",
                "type": "query",
                "description": "userDefinitionKey filter to return results for."
              },
              {
                "name": "userDefinitionName",
                "value": "",
                "type": "query",
                "description": "userDefinitionName filter to return results for."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Search a user"
        },
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/users",
            "params": [
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "From the paginate request.  The sort order, either 'asc' or 'desc'. Defaults to 'asc'."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "From the paginate request. Number of rows to fetch, starting from start. Defaults to 10."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Property to sort the results on"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "From the paginate request. Index of the first row to fetch. Defaults to 0."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Only return users with a state like the given value."
              },
              {
                "name": "subState",
                "value": "",
                "type": "query",
                "description": "Only return users with a sub state like the given value."
              },
              {
                "name": "memberOfGroup",
                "value": "",
                "type": "query",
                "description": "Only return users which are a member of the given group."
              },
              {
                "name": "memberOfGroupKey",
                "value": "",
                "type": "query",
                "description": "Only return users which are a member of the group with the given key."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List users"
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a user"
        },
        {
          "info": {
            "name": "Get a single user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "includeIdentityInfo",
                "value": "",
                "type": "query"
              },
              {
                "name": "includeGroupInfo",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a single user"
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "All request values are optional. For example, you can only include the firstName attribute in the request body JSON-object, only updating the firstName of the user, leaving all other fields unaffected. When an attribute is explicitly included and is set to null, the user-value will be updated to null. Example: {\"firstName\" : null} will clear the firstName of the user)."
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a user"
        },
        {
          "info": {
            "name": "Get an user avatar",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/users/:userId/avatar/data",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "download",
                "value": "",
                "type": "query",
                "description": "Explicitly request the content to be downloaded or viewed in a browser. By default it would be done based on the content media type"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get an user avatar"
        },
        {
          "info": {
            "name": "Updates a user avatar",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/users/:userId/avatar/data",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Updates a user avatar"
        },
        {
          "info": {
            "name": "Get an user avatar thumbnail",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/users/:userId/avatar/thumbnail",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "download",
                "value": "",
                "type": "query",
                "description": "Explicitly request the content to be downloaded or viewed in a browser. By default it would be done based on the content media type"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get an user avatar thumbnail"
        },
        {
          "info": {
            "name": "Change user language",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId/change-language",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Change user language"
        },
        {
          "info": {
            "name": "Change user password",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId/change-password",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Change user password"
        },
        {
          "info": {
            "name": "Change user theme",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId/change-theme",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Change user theme"
        },
        {
          "info": {
            "name": "Delete a user identity info",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/users/:userId/identity-info/:identityInfoName",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "identityInfoName",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a user identity info"
        },
        {
          "info": {
            "name": "Get user from ElasticSearch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/users/:userId/index-document",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get user from ElasticSearch"
        },
        {
          "info": {
            "name": "Get a single user name information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/users/:userId/name",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a single user name information"
        },
        {
          "info": {
            "name": "Update presence",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId/presence",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The id of the user that should get the presence updated. Only users with admin privileges are allowed to set the presence for other users"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Set the presence and / or status text for a user"
        },
        {
          "info": {
            "name": "Update a user state and sub state",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId/update-state",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a user state and sub state"
        },
        {
          "info": {
            "name": "Update a user definition",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/users/:userId/update-user-definition",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a user definition"
        }
      ]
    }
  ],
  "bundled": true
}