{ "info": { "_postman_id": "2b3b584b-dd16-40f7-834d-86c9c1a9439b", "name": "Crowd Data Center", "description": "This is the reference document for the Atlassian Crowd DC REST API. The REST API is for developers who want to: \\n\\n - integrate Crowd with other applications;\\n\\n - create scripts that interact with Crowd; or\\n\\n - develop plugins that enhance the Crowd UI, using REST to interact with the backend. \\n\\n You can read more about developing Crowd plugins in the [Crowd Developer Documentation](https://developer.atlassian.com/server/crowd/).", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Account Management", "item": [ { "name": "Change password", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/account/1/change-password", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Changes user's password", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Forgotten password", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/account/1/forgotten-password", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "username for user whose password is going to be reset" } ], "variable": [] }, "method": "POST", "header": [], "description": "Starts the procedure for forgotten password" }, "response": [] }, { "name": "Forgotten username", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/account/1/forgotten-username", "query": [ { "key": "email", "value": "{{email}}", "disabled": true, "description": "email for user whose username is going to be reset" } ], "variable": [] }, "method": "POST", "header": [], "description": "Starts the procedure for forgotten username" }, "response": [] }, { "name": "Reset password", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/account/1/reset-password", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Resets user's forgotten password", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Validate Token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/account/1/token-status", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Checks whether user's reset token is still valid", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Alias", "item": [ { "name": "Get aliases for user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases", "query": [ { "key": "user", "value": "{{user}}", "disabled": true, "description": "username in Crowd (does not need to exist)" } ], "variable": [] }, "method": "GET", "header": [], "description": "Returns all aliases of the specified user from all alias-enabled applications" }, "response": [] }, { "name": "Set aliases for user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases", "query": [ { "key": "user", "value": "{{user}}", "disabled": true, "description": "username in Crowd (does not need to exist)" } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Sets the alias for the given username in all the applications, replacing the previous alias set for the same username, if they exist. Applications that are not included in the map will have their aliases removed", "body": { "mode": "raw", "raw": "{\n \"applicationid-1\": \"Alias-1\",\n \"applicationid-3\": \"Alias-3\"\n}" } }, "response": [] }, { "name": "Delete aliases for user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases", "query": [ { "key": "user", "value": "{{user}}", "disabled": true, "description": "username in Crowd (does not need to exist)" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Removes all aliases of the specified user from all applications, even from applications where aliasing is disabled" }, "response": [] }, { "name": "Get alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases/:applicationId/alias", "query": [ { "key": "user", "value": "{{user}}", "disabled": true, "description": "username for the alias to be returned" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "unique identifier for the application that the user is part of", "disabled": false } ] }, "method": "GET", "header": [], "description": "Returns the user's alias in the specified application" }, "response": [] }, { "name": "Set alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases/:applicationId/alias", "query": [ { "key": "user", "value": "{{user}}", "disabled": true, "description": "username for alias to be updated" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "unique identifier for the application that the user is part of", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "text/plain" } ], "description": "Sets the user's alias in the specified application", "body": { "mode": "raw" } }, "response": [] }, { "name": "Delete alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases/:applicationId/alias", "query": [ { "key": "user", "value": "{{user}}", "disabled": true, "description": "username for alias to be deleted" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "unique identifier for the application that the user is part of", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes user's alias in a specified application" }, "response": [] }, { "name": "Get username for alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/aliases/:applicationId/username", "query": [ { "key": "alias", "value": "{{alias}}", "disabled": true, "description": "user's alias" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "unique identifier for the application that the user is part of", "disabled": false } ] }, "method": "GET", "header": [], "description": "Returns user's username in a specified application" }, "response": [] } ] }, { "name": "Application", "item": [ { "name": "Get applications", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application", "query": [ { "key": "name", "value": "{{name}}", "disabled": true, "description": "application's name" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns all the applications or a specific application by name" }, "response": [] }, { "name": "Add application", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application", "query": [ { "key": "include-request-address", "value": "{{include-request-address}}", "disabled": true, "description": "whether the request address should be included in the response" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds a new application", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get application by ID", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "application's unique identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the specified application" }, "response": [] }, { "name": "Update application", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "application's unique identifier", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the specified application", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete application", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "application's unique identifier", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Removes the specified application" }, "response": [] }, { "name": "Get remote addresses", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application/:applicationId/remote_address", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "application's unique identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the remote addresses of the specified application" }, "response": [] }, { "name": "Add remote address", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application/:applicationId/remote_address", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "application's unique identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds the remote address to the specified application", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Remove remote address", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/appmanagement/1/application/:applicationId/remote_address", "query": [ { "key": "address", "value": "{{address}}", "disabled": true, "description": "remote address to remove" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "application's unique identifier", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Removes the remote address of the specified application" }, "response": [] } ] }, { "name": "Application Admin", "item": [ { "name": "Get applications", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "name criteria" }, { "key": "active", "value": "{{active}}", "disabled": true, "description": "criteria for status of an application" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a paged list of all applications" }, "response": [] }, { "name": "Get application by ID", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the application with the specified id" }, "response": [] }, { "name": "Update application", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the specified application", "body": { "mode": "raw", "raw": "{\n \"id\": 1900,\n \"name\": \"crowd\",\n \"description\": \"crowd-app\",\n \"type\": \"CROWD\",\n \"active\": true,\n \"aliasingEnabled\": false,\n \"lowercaseOutput\": false,\n \"aggregateMemberships\": false,\n \"cachedDirectoriesAuthenticationOrderOptimisation\": true,\n \"directoryMappings\": null,\n \"filteringUsersWithAccessEnabled\": null,\n \"filteringGroupsWithAccessEnabled\": null\n}" } }, "response": [] }, { "name": "Get access based synchronization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/access-based-synchronization", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the Current Filter Type for Access Based Synchronization for the given Application" }, "response": [] }, { "name": "Update access based synchronization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/access-based-synchronization", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Change the current Filter Type used for Access Based Synchronization for the given Application", "body": { "mode": "raw", "raw": "{\n \"filterType\": \"NO_FILTERING\"\n}" } }, "response": [] }, { "name": "Get directory mappings", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/directory-mapping", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "The directory mappings of the specified application" }, "response": [] }, { "name": "Add directory mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/directory-mapping", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds a directory mapping to the specified application. It is added as the last mapping for the application", "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"name\": null,\n \"authentication\": {\n \"allowAll\": false,\n \"allowGroups\": [\n \"crowd-administrators\"\n ]\n },\n \"defaultGroups\": [\n \"crowd-users\"\n ]\n}" } }, "response": [] }, { "name": "Get directory mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/directory-mapping/:directoryId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false }, { "key": "directoryId", "value": "{{directoryId}}", "description": "the directory's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the specified application's mapping to the specified directory" }, "response": [] }, { "name": "Update directory mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/directory-mapping/:directoryId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false }, { "key": "directoryId", "value": "{{directoryId}}", "description": "the directory's identifier", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the specified directory mapping. The fields specified will overwrite the current values. The unspecified fields will not be changed", "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"name\": null,\n \"authentication\": {\n \"allowAll\": false,\n \"allowGroups\": [\n \"crowd-administrators\"\n ]\n },\n \"defaultGroups\": [\n \"crowd-users\"\n ]\n}" } }, "response": [] }, { "name": "Delete directory mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/directory-mapping/:directoryId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the id of the application to remove the mapping for", "disabled": false }, { "key": "directoryId", "value": "{{directoryId}}", "description": "the id of the directory to remove the mapping for", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes a directory mapping from an application" }, "response": [] }, { "name": "Reorder directory mappings", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/application/:applicationId/directory-mapping/:directoryId/move", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false }, { "key": "directoryId", "value": "{{directoryId}}", "description": "the directory's identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Changes the position of the specified application-directory mapping", "body": { "mode": "raw", "raw": "{\n \"after\": 131073,\n \"position\": 2\n}" } }, "response": [] } ] }, { "name": "Application Licensing", "item": [ { "name": "Get directories", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/licensing/:applicationId/directories", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "version", "value": "{{version}}", "disabled": true, "description": "licensing data version" }, { "key": "jiraType", "value": "{{jiraType}}", "disabled": true, "description": "subtype of Jira, only if the application type is Jira" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of directories linked to the users who are consuming licenses in the given application, matching provided version of data and subtype of the application, if it's Jira" }, "response": [] }, { "name": "Get Jira types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/licensing/:applicationId/jira-types", "query": [ { "key": "version", "value": "{{version}}", "disabled": true, "description": "licensing data version" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of application sub-types available for the given Jira application" }, "response": [] }, { "name": "Export users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/licensing/:applicationId/licensed-users/download", "query": [ { "key": "search", "value": "{{search}}", "disabled": true, "description": "search text" }, { "key": "directoryId", "value": "{{directoryId}}", "disabled": true, "description": "the directory's identifier" }, { "key": "jiraType", "value": "{{jiraType}}", "disabled": true, "description": "subtype, required only for Jira application" }, { "key": "lastLoginBefore", "value": "{{lastLoginBefore}}", "disabled": true, "description": "last logged in date on or before" }, { "key": "searchVersion", "value": "{{searchVersion}}", "disabled": true, "description": "licensing data version" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [], "description": "Returns license consuming users for given application, matching provided restrictions" }, "response": [] }, { "name": "Search users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/licensing/:applicationId/licensed-users/search", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Searches license consuming users along with the total count of users for given application, matching provided restrictions", "body": { "mode": "raw", "raw": "{\n \"search\": \"jon\",\n \"directoryId\": \"5324\",\n \"jiraType\": \"jira-software\",\n \"lastLoginBefore\": 1550008800000,\n \"searchVersion\": 3947145\n}" } }, "response": [] }, { "name": "Get licensing summary", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/licensing/:applicationId/summary", "query": [ { "key": "version", "value": "{{version}}", "disabled": true, "description": "licensing data version" }, { "key": "jiraType", "value": "{{jiraType}}", "disabled": true, "description": "subtype, required only for Jira application" } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Return the licensing summary if available" }, "response": [] } ] }, { "name": "Audit", "item": [ { "name": "Add changeset", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/auditlog", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Stores a changeset in the audit log", "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"timestamp\": \"2017-04-26T00:00:00.000+0300\",\n \"author\": {\n \"id\": 1,\n \"name\": \"admin\",\n \"displayName\": null,\n \"originalName\": null,\n \"type\": \"USER\",\n \"subtype\": null\n },\n \"authorType\": null,\n \"authorId\": null,\n \"authorName\": null,\n \"eventType\": \"APPLICATION_CREATED\",\n \"entityType\": null,\n \"entityId\": null,\n \"entityName\": null,\n \"entities\": [\n {\n \"id\": 12,\n \"name\": \"Jira 7.4\",\n \"displayName\": null,\n \"originalName\": null,\n \"type\": \"APPLICATION\",\n \"subtype\": \"JIRA\",\n \"primary\": true\n }\n ],\n \"ipAddress\": \"127.0.0.1\",\n \"eventMessage\": \"Application modified\",\n \"source\": null,\n \"entries\": [\n {\n \"propertyName\": \"name\",\n \"oldValue\": \"JIRA 7.2\",\n \"newValue\": \"Jira 7.4\"\n }\n ]\n}" } }, "response": [] }, { "name": "Get configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/auditlog/configuration", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves current audit log configuration" }, "response": [] }, { "name": "Set configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/auditlog/configuration", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Saves new audit log configuration", "body": { "mode": "raw", "raw": "{\n \"retentionPeriod\": \"UNLIMITED\"\n}" } }, "response": [] }, { "name": "Search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/auditlog/query", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Searches audit log for entries matching given restrictions. Multiple restrictions for a single category (for example multiple authors) are treated as logical ORs - the resulting changesets must match at least one of them.Restrictions of different categories (for example specifying an author and event type) are treated as logical ANDs - the resulting changesets must match all of them", "body": { "mode": "raw", "raw": "{\n \"onOrAfter\": \"2017-04-26T00:00:00.000+0300\",\n \"beforeOrOn\": \"2017-05-26T00:00:00.000+0300\",\n \"actions\": [\n \"USER_UPDATED\",\n \"APPLICATION_CREATED\"\n ],\n \"sources\": [],\n \"authors\": [\n {\n \"id\": 1,\n \"name\": \"admin\",\n \"type\": \"USER\"\n },\n {\n \"id\": null,\n \"name\": \"jira\",\n \"type\": \"APPLICATION\"\n }\n ],\n \"users\": [\n {\n \"id\": 2,\n \"name\": \"user\"\n }\n ],\n \"groups\": [\n {\n \"id\": 4,\n \"name\": \"jira-administrators\"\n }\n ],\n \"applications\": [\n {\n \"id\": 5,\n \"name\": \"jira\"\n }\n ],\n \"directories\": [\n {\n \"id\": 6,\n \"name\": \"ad\"\n }\n ]\n}" } }, "response": [] }, { "name": "Get filter values", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/auditlog/query/filter", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "search", "value": "{{search}}", "disabled": true, "description": "returns only results with a name starting with the given value" }, { "key": "projection", "value": "{{projection}}", "disabled": true, "description": "the item type requested. Currently supports 'EVENT_TYPE', 'AUTHOR', 'ENTITY_USER', 'ENTITY_GROUP', 'ENTITY_DIRECTORY', 'ENTITY_APPLICATION', 'SOURCE'" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a list of unique items of the chosen type that exist in changesets matching the specified search restriction", "body": { "mode": "raw", "raw": "{\n \"onOrAfter\": \"2017-04-26T00:00:00.000+0300\",\n \"beforeOrOn\": \"2017-05-26T00:00:00.000+0300\",\n \"actions\": [\n \"USER_UPDATED\",\n \"APPLICATION_CREATED\"\n ],\n \"sources\": [],\n \"authors\": [\n {\n \"id\": 1,\n \"name\": \"admin\",\n \"type\": \"USER\"\n },\n {\n \"id\": null,\n \"name\": \"jira\",\n \"type\": \"APPLICATION\"\n }\n ],\n \"users\": [\n {\n \"id\": 2,\n \"name\": \"user\"\n }\n ],\n \"groups\": [\n {\n \"id\": 4,\n \"name\": \"jira-administrators\"\n }\n ],\n \"applications\": [\n {\n \"id\": 5,\n \"name\": \"jira\"\n }\n ],\n \"directories\": [\n {\n \"id\": 6,\n \"name\": \"ad\"\n }\n ]\n}" } }, "response": [] } ] }, { "name": "Backup", "item": [ { "name": "Create backup", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/backup", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates manual backup", "body": { "mode": "raw", "raw": "{\n \"fileName\": \"myBackup.xml\"\n}" } }, "response": [] }, { "name": "Get configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/backup/configuration", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns backup configuration" }, "response": [] }, { "name": "Save configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/backup/configuration", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Saves backup configuration", "body": { "mode": "raw", "raw": "{\n \"dailyBackupTime\": 870,\n \"resetDomainEnabled\": true,\n \"backupConnectorEnabled\": false,\n \"scheduledBackupEnabled\": true\n}" } }, "response": [] }, { "name": "Get summary", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/backup/summary", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns backup summary" }, "response": [] } ] }, { "name": "Cookie Configuration", "item": [ { "name": "Get configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/config/cookie", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the Cookie configuration information" }, "response": [] } ] }, { "name": "Directory", "item": [ { "name": "Test Microsoft Entra ID connection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testazuread", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests connection to the specified Microsoft Entra ID", "body": { "mode": "raw", "raw": "{\n \"tenantId\": \"example.onmicrosoft.com\",\n \"webAppId\": \"1a23b45c-de67-8ce0-881c-b43acfee0x34\",\n \"webAppSecret\": \"X70mv+pzvXoiib3OYwaRPVmzoFgq1eDpYUnGm0JTfzQ=\",\n \"nativeAppId\": \"a1af321g-j123-4ter-84x2-a456d3987aa1\",\n \"graphEndpoint\": \"https://graph.microsoft.com\",\n \"authorityEndpoint\": \"https://login.windows.net\",\n \"region\": \"GERMANY\"\n}" } }, "response": [] }, { "name": "Test Microsoft Entra ID connection for directory", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testazuread/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "database id of the directory to test", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests connection to the specified Microsoft Entra ID. Should be used for existing directories", "body": { "mode": "raw", "raw": "{\n \"tenantId\": \"example.onmicrosoft.com\",\n \"webAppId\": \"1a23b45c-de67-8ce0-881c-b43acfee0x34\",\n \"webAppSecret\": \"X70mv+pzvXoiib3OYwaRPVmzoFgq1eDpYUnGm0JTfzQ=\",\n \"nativeAppId\": \"a1af321g-j123-4ter-84x2-a456d3987aa1\",\n \"graphEndpoint\": \"https://graph.microsoft.com\",\n \"authorityEndpoint\": \"https://login.windows.net\",\n \"region\": \"GERMANY\"\n}" } }, "response": [] }, { "name": "Test Crowd connection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testcrowd", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests connection to the specified Remote Crowd directory", "body": { "mode": "raw", "raw": "{\n \"url\": \"http://127.0.0.1:8095/crowd\",\n \"applicationName\": \"application\",\n \"applicationPassword\": \"application_password\",\n \"httpProxyHost\": \"\",\n \"httpProxyPort\": null,\n \"httpProxyUsername\": \"\",\n \"httpProxyPassword\": \"\"\n}" } }, "response": [] }, { "name": "Test Crowd connection for directory", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testcrowd/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "id of the Crowd server which will have its settings changed", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests connection to the specified Remote Crowd directory. Should be used for existing directories", "body": { "mode": "raw", "raw": "{\n \"url\": \"http://127.0.0.1:8095/crowd\",\n \"applicationName\": \"application\",\n \"applicationPassword\": \"application_password\",\n \"httpProxyHost\": \"\",\n \"httpProxyPort\": null,\n \"httpProxyUsername\": \"\",\n \"httpProxyPassword\": \"\"\n}" } }, "response": [] }, { "name": "Test LDAP connection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testldap", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests connection to the specified LDAP server", "body": { "mode": "raw", "raw": "{\n \"url\": \"ldap://localhost:389/\",\n \"secureMode\": \"NONE\",\n \"baseDN\": \"dc=test,dc=com\",\n \"ldapPassword\": \"admin\",\n \"userDN\": \"cn=admin,dc=test,dc=com\",\n \"connector\": \"com.atlassian.crowd.directory.OpenLDAP\",\n \"referral\": false,\n \"userEncryptionMethod\": null,\n \"groupDNaddition\": null,\n \"groupDescriptionAttr\": null,\n \"groupMemberAttr\": null,\n \"groupNameAttr\": null,\n \"groupObjectClass\": null,\n \"groupObjectFilter\": null,\n \"userDNaddition\": null,\n \"userObjectClass\": null,\n \"userGroupMemberAttr\": null,\n \"userFirstnameAttr\": null,\n \"userLastnameAttr\": null,\n \"userDisplayNameAttr\": null,\n \"userMailAttr\": null,\n \"userNameAttr\": null,\n \"userNameRdnAttr\": null,\n \"userPasswordAttr\": null,\n \"userObjectFilter\": null,\n \"userExternalIdAttr\": null\n}" } }, "response": [] }, { "name": "Test LDAP connection for directory", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testldap/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "the database id of the directory to test", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests connection to the specified LDAP server. Should be used for existing directories", "body": { "mode": "raw", "raw": "{\n \"url\": \"ldap://localhost:389/\",\n \"secureMode\": \"NONE\",\n \"baseDN\": \"dc=test,dc=com\",\n \"ldapPassword\": \"admin\",\n \"userDN\": \"cn=admin,dc=test,dc=com\",\n \"connector\": \"com.atlassian.crowd.directory.OpenLDAP\",\n \"referral\": false,\n \"userEncryptionMethod\": null,\n \"groupDNaddition\": null,\n \"groupDescriptionAttr\": null,\n \"groupMemberAttr\": null,\n \"groupNameAttr\": null,\n \"groupObjectClass\": null,\n \"groupObjectFilter\": null,\n \"userDNaddition\": null,\n \"userObjectClass\": null,\n \"userGroupMemberAttr\": null,\n \"userFirstnameAttr\": null,\n \"userLastnameAttr\": null,\n \"userDisplayNameAttr\": null,\n \"userMailAttr\": null,\n \"userNameAttr\": null,\n \"userNameRdnAttr\": null,\n \"userPasswordAttr\": null,\n \"userObjectFilter\": null,\n \"userExternalIdAttr\": null\n}" } }, "response": [] }, { "name": "Test LDAP search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testsearch", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests search with the provided LDAP directory configuration", "body": { "mode": "raw", "raw": "{\n \"strategy\": \"GROUP\",\n \"url\": \"ldap://localhost:389/\",\n \"secureMode\": \"NONE\",\n \"referral\": false,\n \"baseDN\": \"dc=test,dc=com\",\n \"userDN\": \"cn=admin,dc=test,dc=com\",\n \"ldapPassword\": \"admin\",\n \"userEncryptionMethod\": null,\n \"filterExpiredUsers\": false,\n \"primaryGroupSupport\": false,\n \"useUserMembershipAttribute\": false,\n \"useUserMembershipAttributeForGroupMembership\": false,\n \"useRelaxedDNStandardisation\": false,\n \"pagedResults\": false,\n \"pagedResultsSize\": null,\n \"groupDNaddition\": null,\n \"groupDescriptionAttr\": null,\n \"groupMemberAttr\": null,\n \"groupNameAttr\": \"cn\",\n \"groupObjectClass\": null,\n \"groupObjectFilter\": \"(objectCategory=Group)\",\n \"userDNaddition\": null,\n \"userObjectClass\": null,\n \"userGroupMemberAttr\": null,\n \"userFirstnameAttr\": null,\n \"userLastnameAttr\": null,\n \"userDisplayNameAttr\": null,\n \"userMailAttr\": null,\n \"userNameAttr\": null,\n \"userNameRdnAttr\": null,\n \"userPasswordAttr\": null,\n \"userObjectFilter\": null,\n \"userExternalIdAttr\": null,\n \"connector\": \"com.atlassian.crowd.directory.OpenLDAP\"\n}" } }, "response": [] }, { "name": "Test LDAP search for directory", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/directorymanagement/1/directory/testsearch/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "database id of the directory for which the settings will be tested", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Tests search with the provided LDAP directory configuration. Should be used for existing directories", "body": { "mode": "raw", "raw": "{\n \"strategy\": \"GROUP\",\n \"url\": \"ldap://localhost:389/\",\n \"secureMode\": \"NONE\",\n \"referral\": false,\n \"baseDN\": \"dc=test,dc=com\",\n \"userDN\": \"cn=admin,dc=test,dc=com\",\n \"ldapPassword\": \"admin\",\n \"userEncryptionMethod\": null,\n \"filterExpiredUsers\": false,\n \"primaryGroupSupport\": false,\n \"useUserMembershipAttribute\": false,\n \"useUserMembershipAttributeForGroupMembership\": false,\n \"useRelaxedDNStandardisation\": false,\n \"pagedResults\": false,\n \"pagedResultsSize\": null,\n \"groupDNaddition\": null,\n \"groupDescriptionAttr\": null,\n \"groupMemberAttr\": null,\n \"groupNameAttr\": \"cn\",\n \"groupObjectClass\": null,\n \"groupObjectFilter\": \"(objectCategory=Group)\",\n \"userDNaddition\": null,\n \"userObjectClass\": null,\n \"userGroupMemberAttr\": null,\n \"userFirstnameAttr\": null,\n \"userLastnameAttr\": null,\n \"userDisplayNameAttr\": null,\n \"userMailAttr\": null,\n \"userNameAttr\": null,\n \"userNameRdnAttr\": null,\n \"userPasswordAttr\": null,\n \"userObjectFilter\": null,\n \"userExternalIdAttr\": null,\n \"connector\": \"com.atlassian.crowd.directory.OpenLDAP\"\n}" } }, "response": [] } ] }, { "name": "Directory Admin", "item": [ { "name": "Get detailed directory data list", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/directory/detailed", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "search", "value": "{{search}}", "disabled": true, "description": "search request query" }, { "key": "active", "value": "{{active}}", "disabled": true, "description": "the status of the directories to search" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists detailed directory data for all directories which match the search and active criteria queried by the System Admin" }, "response": [] }, { "name": "Get detailed directory data", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/directory/detailed/:directoryId", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "the directory's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves detailed directory data for directory specified by ID by system admin" }, "response": [] }, { "name": "Schedule synchronisation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/directory/detailed/:directoryId/synchronize", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "the directory's identifier", "disabled": false } ] }, "method": "POST", "header": [], "description": "Schedules a Synchronisation for the given directory specified" }, "response": [] }, { "name": "Get managed directories", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/directory/managed", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the directories managed by the logged in user" }, "response": [] } ] }, { "name": "Group Admin", "item": [ { "name": "Search directory groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group/search/:directoryId", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "term", "value": "{{term}}", "disabled": true, "description": "the search term" }, { "key": "active", "value": "{{active}}", "disabled": true, "description": "status of the groups to search" } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "the id of the directory to search", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Searches the given directory for groups matching the search term" }, "response": [] }, { "name": "Get nested groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group/:groupId/groups", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns group's direct members (groups)" }, "response": [] }, { "name": "Add groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group/:groupId/groups", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds multiple groups to a single group placed in the same directory", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"1900-Y3Jvd2QtdXNlcnM\",\n \"1900-YmFkZ2Vycw\",\n \"1900-c3Rhc2gtdXNlcnM\"\n ]\n}" } }, "response": [] } ] }, { "name": "Group Level Admin", "item": [ { "name": "Get group administrators", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group-level-admin/:groupId/admins", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the group-level admins for the specified group" }, "response": [] }, { "name": "Add group administrators", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group-level-admin/:groupId/admins", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants the rights to administer the specified group to the specified directory entities", "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"1-dXNlcjE\",\n \"type\": \"USER\"\n },\n {\n \"id\": \"2-Z3JvdXAx\",\n \"type\": \"GROUP\"\n }\n]" } }, "response": [] }, { "name": "Revoke group to group administrator", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group-level-admin/:groupId/admins/groups/:adminId", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the identifier of the group to which the rights will be revoked", "disabled": false }, { "key": "adminId", "value": "{{adminId}}", "description": "the identifier of the group from which the rights will be revoked", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Revokes the rights to administer the given group from the specified group" }, "response": [] }, { "name": "Get administrator candidates", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group-level-admin/:groupId/admins/suggestions", "query": [ { "key": "search", "value": "{{search}}", "disabled": true, "description": "user/group search string" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the search" } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the unique identifier of the group", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns users and groups that can become admins of the given group" }, "response": [] }, { "name": "Revoke user to group administrator", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/group-level-admin/:groupId/admins/users/:adminId", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the identifier of the group to which the rights will be revoked", "disabled": false }, { "key": "adminId", "value": "{{adminId}}", "description": "the identifier of the user from whom the rights will be revoked", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Revokes the rights to administer the given group from the specified user" }, "response": [] } ] }, { "name": "Groups", "item": [ { "name": "Get group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "name of the group to retrieve" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a group" }, "response": [] }, { "name": "Update group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "the name of the group to update" } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates an existing group", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"name\": \"newgroupname\",\n \"description\": \"description\",\n \"type\": \"GROUP\",\n \"active\": null,\n \"attributes\": null,\n \"expanded\": true\n}" } }, "response": [] }, { "name": "Add group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds a new group", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"name\": \"newgroupname\",\n \"description\": \"description\",\n \"type\": \"GROUP\",\n \"active\": null,\n \"attributes\": null,\n \"expanded\": true\n}" } }, "response": [] }, { "name": "Delete group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "the name of the group to delete" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a group" }, "response": [] }, { "name": "Get group attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/attribute", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "the name of the group to fetch attributes from" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of group attributes" }, "response": [] }, { "name": "Save group attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/attribute", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "the name of the group" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Stores the group attributes", "body": { "mode": "raw", "raw": "{\n \"link\": {\n \"href\": \"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?username=sampleuser\",\n \"rel\": \"self\"\n },\n \"attribute\": [\n {\n \"link\": {\n \"href\": \"https://crowdserver/crowd\",\n \"rel\": \"self\"\n },\n \"name\": \"attribute\",\n \"values\": [\n \"value1\",\n \"value2\"\n ]\n }\n ]\n}" } }, "response": [] }, { "name": "Delete group attribute", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/attribute", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "the name of the group" }, { "key": "attributename", "value": "{{attributename}}", "disabled": true, "description": "the name of the attribute to delete" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a group attribute" }, "response": [] }, { "name": "Get direct group children", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/child-group/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the parent group which will have its children fetched" }, { "key": "child-groupname", "value": "{{child-groupname}}", "disabled": true, "description": "if specified then only the direct child group with this name will be returned" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index if using paged queries, only applicable when 'child-groupname' is not provided" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum amount of results to return, only applicable when 'child-groupname' is not provided" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the groups that are direct children of the specified group or a single direct child of that group with the specified name" }, "response": [] }, { "name": "Add direct child group membership", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/child-group/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the parent group to which the direct child group will be added" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds a direct child group membership", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"name\": \"groupname\",\n \"description\": null,\n \"type\": null,\n \"active\": null,\n \"attributes\": null,\n \"expanded\": true\n}" } }, "response": [] }, { "name": "Delete child group membership", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/child-group/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the parent group" }, { "key": "child-groupname", "value": "{{child-groupname}}", "disabled": false, "description": "name of the child group" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a child group membership" }, "response": [] }, { "name": "Get nested children of group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/child-group/nested", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the parent group which will have its nested children fetched" }, { "key": "child-groupname", "value": "{{child-groupname}}", "disabled": true, "description": "if provided then only a single nested child group with this name will be fetched from the group specified by 'groupname'" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index if using paged queries, only applicable when 'child-groupname' is not provided" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum amount of results to return, only applicable when 'child-groupname' is not provided" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves nested children of the specified group or a single nested child of that group with the specified name" }, "response": [] }, { "name": "Get all memberships", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/membership", "query": [], "variable": [] }, "method": "GET", "header": [], "description": "Retrieves full details of all group memberships, with users and nested groups. This resource is optimised for streaming XML responses, and does not support JSON responses" }, "response": [] }, { "name": "Get direct group parents", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/parent-group/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "if 'child-groupname' is specified then the direct parents of this group will be returned. Otherwise this is the direct parent group" }, { "key": "child-groupname", "value": "{{child-groupname}}", "disabled": true, "description": "if specified this will return a single direct parent group of this group with the name 'groupname'" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index if using paged queries, only applicable when 'child-groupname' is not provided" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum amount of results to return, only applicable when 'child-groupname' is not provided" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the groups that are direct parents of the specified group or a direct parent group of the specified child group" }, "response": [] }, { "name": "Add direct parent group membership", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/parent-group/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "if specified this will return a single direct parent group of this group with the name 'groupname'" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds a direct parent group membership", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"name\": \"sampleuser\",\n \"firstName\": null,\n \"lastName\": null,\n \"displayName\": null,\n \"directoryId\": null,\n \"password\": null,\n \"encryptedPassword\": null,\n \"key\": null,\n \"createdDate\": null,\n \"updatedDate\": null,\n \"directoryName\": null,\n \"active\": null,\n \"attributes\": null,\n \"email\": null,\n \"expanded\": true\n}" } }, "response": [] }, { "name": "Get nested parent groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/parent-group/nested", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the group of which the nested parents will be returned" }, { "key": "parent-groupname", "value": "{{parent-groupname}}", "disabled": true, "description": "if specified then the single nested parent group with this name of the group specified by 'groupname' will be returned" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index if using paged queries, only applicable when 'groupname' is not provided" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum amount of results to return, only applicable when 'groupname' is not provided" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the groups that are nested parents of the specified group or a single nested parent of that group with the specified name" }, "response": [] }, { "name": "Get direct members of group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/user/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "the name of the group" }, { "key": "username", "value": "{{username}}", "disabled": true, "description": "if specified it will return a single user if the user is a direct member of the specified group" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index if using paged queries, only applicable when username is not provided" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum amount of results to return, only applicable when username is not provided" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the users that are direct members of the specified group or a specified user who is a direct member of that group" }, "response": [] }, { "name": "Add user group membership", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/user/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the group to which the user will be added" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds a user as a direct member of the specified group", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"name\": \"sampleuser\",\n \"firstName\": null,\n \"lastName\": null,\n \"displayName\": null,\n \"directoryId\": null,\n \"password\": null,\n \"encryptedPassword\": null,\n \"key\": null,\n \"createdDate\": null,\n \"updatedDate\": null,\n \"directoryName\": null,\n \"active\": null,\n \"attributes\": null,\n \"email\": null,\n \"expanded\": true\n}" } }, "response": [] }, { "name": "Remove user group membership", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/user/direct", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the group from which the user membership will be removed" }, { "key": "username", "value": "{{username}}", "disabled": false, "description": "name the user to have their membership removed" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Removes the user membership" }, "response": [] }, { "name": "Get nested group members", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/group/user/nested", "query": [ { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the group" }, { "key": "username", "value": "{{username}}", "disabled": true, "description": "if specified it will return a single user if the user is a nested member of the specified group" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index if using paged queries, only applicable when username is not provided" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum amount of results to return, only applicable when username is not provided" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the users that are nested members of the specified group or a single user who is a nested member of the specified group" }, "response": [] } ] }, { "name": "Groups Membership", "item": [ { "name": "Search administered groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/groups/query", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns groups that are administered by logged in user", "body": { "mode": "raw", "raw": "\"{\\n \\\"search\\\" : \\\"admins\\\",\\n \\\"directoryId\\\" : 1900\\n}\\\"\\n\"" } }, "response": [] }, { "name": "Get group details", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/groups/:groupId", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns group details" }, "response": [] }, { "name": "Get group members", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/groups/:groupId/users", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns group's direct members (users)" }, "response": [] }, { "name": "Add users to group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/groups/:groupId/users", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds multiple users to a single group placed in the same directory", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"1900-Z3JvdXAx\",\n \"1900-Z3JvdXAy\",\n \"1900-Z3JvdXAz\"\n ]\n}" } }, "response": [] }, { "name": "Remove users from group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/groups/:groupId/users", "query": [], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Removes multiple users from single group placed in the same directory", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"1900-Z3JvdXAx\",\n \"1900-Z3JvdXAy\",\n \"1900-Z3JvdXAz\"\n ]\n}" } }, "response": [] }, { "name": "Search users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/groups/:groupId/users/suggestions", "query": [ { "key": "search", "value": "{{search}}", "disabled": true, "description": "user search string" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the search" } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "the group's unique identifier to which users would be assigned", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns users that can be assigned to the given group" }, "response": [] } ] }, { "name": "LDAP Connection Pool", "item": [ { "name": "Get statistics", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/dynamic-ldap-pool-statistics", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the statistics of the Dynamic LDAP connection pools per directory" }, "response": [] } ] }, { "name": "Look and Feel", "item": [ { "name": "Get configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/look-and-feel/config", "query": [], "variable": [] }, "method": "GET", "header": [], "description": "Returns Look and Feel configuration if configured, empty body otherwise" }, "response": [] }, { "name": "Update configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/look-and-feel/config", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Saves Look and Feel configuration", "body": { "mode": "raw", "raw": "{\n \"showLogo\": true,\n \"logo\": \"iVBORw0KGgoAAAANSUhEUgAAAKEAAAChCAYAAACvUd+2AAAACXBIWXMAABYlAAAWJQFJUiTwAAAOu0lEQVR4nO2da2wU1xXHz8y+vLu218YQh7QqRCD1I0SqqlZKS6S2XyKlJYpalCoSBrG8oiROSh7LmkdCliUhBEMJpVkc7IYSmUAwVSO1UqPiiKhfKhVLlapKQON+KVIrgdsEe+31TjX2XTw7nvfcO/fO7vlJq+Cd3bvz+Oece885915JURRAEJ7IePcR3qAIEe6gCBHuoAgR7qAIEe6gCBHuoAgR7qAIEe6gCBHuoAgR7qAIEe6gCBHuoAgR7qAIEe6gCBHuoAgR7qAIEe6gCBHuoAgR7kTxEXgjXyytB4AeAHgUAP4JACcKuWx/GK+FNzjRyQX5YmktAPQCgCrAjME3KwDwGQD0FXLZq8JeiGCgCG3IF0sriehU8a1w8dVJADgHAAcKuew4l5MPCShCA/LFUgcRnupu11Fo8gYAfFjIZXPUT7YBQBFqIP289Rbu1i/qzR4DgEOFXHaYxzWKSNOLkLjbWj/Pjbv1i+qufw8AR5q9/9iUIiTutoe81ghwSrcA4ONCLrtFgHMJnKYSoSas8iMBTscI9WHcbLZwT8OL0EFYRVSaJtzTkCL0EVYRlYYO9zSMCBmEVUSl4cI9oRdhAGEVUWmYcE8oRcgxrCIqoQ73hEaEAoZVRCV04R7hRRiCsIqohCbcI6QIQxxWERWhwz3CiLABwyqiIly4h6sImyisIipChHu4iLCJwyqiwjXcE5gIMawSGgIP9zAVIYZVQs9cuId1/5GJCPPF0iPE6mFYpTGohXvyLNw1dRHmi6VBANhItVFEJAZoB8KpipBYwD9SaxAREVUwD9J0z7Qnvz9CuT1EPCQA2E7zrGiLcCXl9hAx+TbNs6Itws8pt4eIyXWaZ4Vr0SBe+CvNu4YiRLiDIkS4gyJEuIMiRLhDW4TX8JEibqEtwjv4BJqCSzQvEt0x4hraFTUoQoQ7KEKEOyhChDu4ej/iGFZF+FQtYSGXvUKzPYQPqtjmX0rdSy0lZFGJj5awSVnQkrGo5o8bHqMehkMRemNM8zBWA0Ca/LtVpHvqTGjGxxcbPPKGJFE7vxooQmeoolPnzlwp5LK2WaF8sdRL5tl8HQCSrE/OmZjshLjwOauv0JcgitCKCQBQFxIaLOSyrop1yQJEc4sQ5YulDepbALDKz8n4cJ+mVs2qyXtSDGBaOorQmFdVERVyWd/9HzJFcjhfLD1MrKmpGFm4T5smLcUWlBBZiHAixEt7qG53vVvL5wSymsFq1VUrChyev/fs3Sc4ENPccUX/nu0PU4NFsDqslTTHCrnsWhYC1DLvqpXViqLc0odAtGGQhTDJQqikqv4X9N+ZV4xieIy0aXK8WmuTaLD+O7p2FnQ4RfueoDueZ1Mhlx0M6scO7t6qFgAszxXeva4oCnHP7NynlVUzGwQrpj5Y+rvJAc9g2i5gAWop5req4Z0bWstnZ9XMXlWt9bSzauRzVaO2QGc9DSwibZpdhM/zEmCNQ33bNEK0d5+OhabJfCwSm63QtMfruwQs+obN7I6HRFnLWZLge4oCf1MUZS6mSNV9Wh1f5L3rP2OkNxa2sFkt4ThZNUwIDvVtH5ckaZMyD133qWtD/92q4WdAN0jSDYQow0KEYViFoYdGDJAmb+zZPizL8qe03ac3oSmLBavpKtCmGUU4Kmq1z5t7d6gLSlVcC81SbPZCMzterS7+HdpLgECTuuP9ApyDKbIsDbkXmrX7tBOikdjqvwNaEVJdAgSaUITCWsEah/ft3DL3uCm5TzuhWbdpEDxncM3NNjrmGo5xSkSWx2Yqs2uNP06C2kYj1yByzxii8c1IGE5SkqQhAGWt2fMOsnSr7hMKhmj8MiraiNiMt/Y/3a8okkLFfVLOPbPwxywsoaij41DNf5FlmKhUlI75vyiXbrnMSysm/6ZFM4kwVNU9kiSNASjraJdueSly0B6XJLpLgECT9QnDtk7O7ariXkxWx50KTf+Gth/Yf+BZ6pvqNE2fMGzTUSWQRq1ScVb9OLNCB1dFDiaZGhawsIS4PBwF7onLp/vU/uG3yEGSJCYqpG4JwzICFZ571olv6ZY2SxOJyBMsbhurPmGY55kIgUIU4aV0y97i6d6o/WX4tYXgOCt3zKpPKJxLJluehYZqVVnntXSLVe45EpHHWNw/VpbwcwF3cu8Q4Bwco1SVTq9Wzdxgmaf8asetszTSbSoXp4OVJRQxVmiSixWTyuzsGm9WjW7pljYTI0vSKIubxcoSijhCDpU7nqlUMoqFZbK2atYWz2vuWZLgz3bn7YWm6ROq3QOyE73wPLO7f0O1SpLHLmfd1SwetdIt0oYkgfLOoReusrh3TETIegK5D9YLel51zFQqr9i7T6dCs64zdFrkEIlEmYRngHHGhEn/wSc9Ap7TIspT02uciM1OaGZWzUxoVhU10UiEycgYGItQxDSZ6pKFHqDseOnI6dlqVfLrPq3E5qZ0q/aeLEt/YnXNLAsYRE3f9Ys8SJmcKm9UDEYUvEq3aj8uy/Ipu3P3SrNZQiDWUEgRbtt1+EqlMht1atGcWDWzY25SgrFodPIXb/6MevVMDWYiJDlkZv0InwyKNlLe+fKRDXenpr5bLxhnQmO9bEg0FqW+CJIW1qVcos7pWFFbSVUEdr789oq7k+Uz1VlFMhKZldCsxOa1dEv/ikTk37G8Tc0qQpWN+WJJiNFyeXr6k+npmSQt9+m2RtBY8AtdgtNvv5xjef1MRUgWGWfWl6DAGd5C3NxbvH737tQqmu6T5rIhyZbELdb3IIjKatGnWXIT4pwAJ8uraLtPW6EZiM0s9xyLRT9mfR+CEGEYJpyrQgysj7jjpSMrep49+K8viQWk7T7theasdGu+Pxg5wPp+kPwkW/LF0udkMCA6zBZOr7F11+HeL768e1gNxdQdcFyCr3vDc+mWfZFDazp54+zJPavNr4YOQc22U63hvoB+yw9rAOAf+WKJ2hYSNba9+NbD5fL04Fz/j1Hls1WjRsetKmZU4vHYCbNWaRKUJVypPtwgLoginjfT0bJ115sbytMzBVV8c297EhpYFpyyKN2KRaOVC++9HjP7RZoEIkKYF+Ig2WorjKhuen8hl3U8yNr8XPFKeXrmm+XpGbKtGHv3qf+dxcetjtX/VkembeRXJ/oeNztTmgQ57zgUK2KZoLrpS06LHzb3Fi/994sv102Vp5N2o0+rQYH+WFClW7IkK7FYNLDllAMTIZl8LmJ5lxsc5ZyrVaXTWgjWQqRXumUuNKuUYDKZuDlw9JXA4rtBr8Ag9CqpDnDkjmVZuu5VaNbfc1u65S333NKSCDRuGlifsEa+WLoi4Ew8J6hLyzmuvnlic191drZKdma164uJU7rV1pq6Mfzuq8zDMlp4rEUTVmvoKpidTrV8GpT7XPTykXtOBmwFgYcIQ9o3HHczMlaJx6J9QblPt0Kb/+7ilGBHpnV08PhuJpOZrOC1KlfYrKHrlN7po69cTaeTNxxZNRdCsxKbn9yzLEtKIh7nEkLjIkJiDYd4/LYHJryGlxKx2IkgKp9p5J4z7W2XB4/v5lLxxHN9wl7ygEVnxGv67szx3f3xeGySdeWz39KteCI2+cGpfYEEpo3gJkLyYMPgln2dYyrZcq5ObF6F5tCaeind6mhv3UTvdrkn8BCNHsFDNq7CMmY89tRL1cq9cI2bihmjqoO6//jOPS/pbB89X3qN68QvEZYL7hHYLVNJNaZTyTGa7tPbhomLj7Uk4pO8BQgiiJBUqAiz7auGcVobcicS8Wdouk9auedMhq8briHEwunkYYs2WqZWcDH08/zV1nTqlnOh2RUh+M89L13SMfLrk3uHaV2jH0Ravb9XsHnKVMv9ky2JN/y6TydCc9JmW2vq1vnTr3EbDesRRoRktCxK/3CI9gLwZ0/u6VcLRf24TzOrZm0169tIJOKT7e3pb9G8Nr8ItY8JmSIqwlxgJpOeMu3pIa/u016I9rlnWY4oSzraN519Z49Q03CF20yH5Gh5dpjHyP8M1InGogfU9Ji55XIiNO+55+5lnU+eO7VPiH6gFiF3dOI8UGE29fP9E33jrenUTX9CMxCbkXh1QuxetmTgg1/uF06AIPK2YoVctoeDECdohWXMSKdaeoIu3eq+r2vgw4EDW1helx+E3tuOgxCZT4A/e3Lv1XSq5Y4bofnJPS/t6hi9ILAAIQwbLAYsxEAmY7WmU6ecCm2R2AyEtmAR63PPnZm2GyODB4XftYB77tgpAUwZHSKCD4TvP/HcTHl65t7iA4ur+XU5YYM/rHLPS7s6rv3m/UMPBXU9fgjNVrMBWMRAp6RmMm2/dWPVjPqAZgOT+7u7BsIiQAjbfscMhTgW9H7IiXisNxKJ1PRHrXRreXfXwEdnCkL3AfWEbtNtIkTaccTAV209d2rfeFtr6iatVbcisqx89YHu5z86czBUAoSw7vxOwiiPU0rxTfBaQzGdaskbWzVjoRnFEtUvxeOxygPLlz55YeCAMEsguyE0AxMjyLIcg2SZDq8cK+Sy3ErJfvDj3tv/++Lu3CLuxo/Ceg2a9rbUna4lHWuH331V5BVxLQmlJaxB0mtqCOKyj2a4Wo/WdOqi19Kt+5Z1jv7hwrHOMAsQwm4JteSLJdWaHXX5tcuFXJb7fnff+eHTM+VyeS5c4+RxRKMR5YH7l71w8b3XQ+l+9YTaEmop5LLqA3nIZU2iEA8x057+7F72xIb2tvSdr33l/gcbRYDQSCKEevd8zMHHx4MOy5iRTiZtg/Cq9VvevXTkk4vHOodL4Xa/ehrGHeshW4cNWqyV/bjbpT1Y8uhPX/zLv/9z23D9Q9X6dXVmHjt/+rXAl+gIgoYVYY18sbSfTB3IkLfUkEwv62oZL+iFqFq/7mVL3hsZKoYu9ueGhhchzAtRDYHUHu412qX7NPnJlr0Pz1ar31CbbKR+nxVNIUJEbBpqYIKEExQhwh0UIcIdFCHCHRQhwh0UIcIdFCHCHRQhwh0UIcIdFCHCHRQhwh0UIcIdFCHCHRQhwh0UIcIdFCHCHRQhwh0UIcIdFCHCFwD4PxoR7lARjrBCAAAAAElFTkSuQmCC\",\n \"customLogoId\": \"logo-123\",\n \"header\": \"Hello!\",\n \"welcomeText\": \"Provide your credentials bellow.\",\n \"primaryColor\": \"#121212\",\n \"showAnnouncement\": false,\n \"announcementText\": \"Announcement\"\n}" } }, "response": [] }, { "name": "Delete configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/look-and-feel/reset-config", "query": [], "variable": [] }, "method": "POST", "header": [], "description": "Removes Look and Feel configuration" }, "response": [] } ] }, { "name": "Mail Server", "item": [ { "name": "Save configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/mail/configuration", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Saves mail configuration", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Test mail server connection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/mail/configuration/test", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Tests connection to the specified SMTP server", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Validate fields", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/mail/configuration/validate", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Validates fields required in test connection for mail server", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Remember Me", "item": [ { "name": "Get configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/remember-me/config", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the current remember-me configuration" }, "response": [] }, { "name": "Update configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/remember-me/config", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates the remember me configuration", "body": { "mode": "raw", "raw": "{\n \"expirationPeriod\": 300,\n \"enabled\": true\n}" } }, "response": [] }, { "name": "Expire all tokens", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/remember-me/expire-all", "query": [], "variable": [] }, "method": "POST", "header": [], "description": "Expires all active remember-me tokens" }, "response": [] } ] }, { "name": "SAML Configuration", "item": [ { "name": "Get configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the global SAML configuration" }, "response": [] }, { "name": "Parse metadata", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/application/parse_metadata", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/octet-stream" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Parses application metadata.", "body": { "mode": "raw", "raw": "\n \n \n \"\n\"\n" } }, "response": [] }, { "name": "Parse metadata file", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/application/parse_metadata_multipart", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "multipart/form-data" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Parses application metadata.", "body": { "mode": "formdata", "formdata": [ { "key": "contentType", "disabled": true, "type": "text", "value": "{{contentType}}" }, { "key": "formField", "disabled": true, "type": "text", "value": "{{formField}}" }, { "key": "inputStream", "disabled": true, "type": "text", "value": "{{inputStream}}" }, { "key": "name", "disabled": true, "type": "text", "value": "{{name}}" }, { "key": "size", "disabled": true, "type": "text", "value": "{{size}}" }, { "key": "value", "disabled": true, "type": "text", "value": "{{value}}" } ] } }, "response": [] }, { "name": "Get application configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns SAML configuration" }, "response": [] }, { "name": "Update application configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/application/:applicationId", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates SAML configuration for a specified application", "body": { "mode": "raw", "raw": "{\n \"entityId\": \"http://my.service.com\",\n \"assertionConsumerUrl\": \"http://my.service.com/SAML2/SSO/POST\",\n \"enabled\": true,\n \"nameIdFormat\": \"UNSPECIFIED\",\n \"addUserAttributesEnabled\": false\n}" } }, "response": [] }, { "name": "Find directory mappings mismatch", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/application/:applicationId/directory-mapping-mismatch", "query": [], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "the application's identifier to compare with crowd", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Compares the directory mappings of application with crowd application" }, "response": [] }, { "name": "Get identity provider metadata", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/idp/metadata", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/xml" } ], "description": "Returns Identity provider's metadata" }, "response": [] }, { "name": "Reset configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/samlconfig/reset-certificates", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Replaces the private key/certificate pair used for signing/verifying assertions with a new one" }, "response": [] } ] }, { "name": "Search", "item": [ { "name": "Search by CQL", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/search", "query": [ { "key": "entity-type", "value": "{{entity-type}}", "disabled": false, "description": "type of the entity to search" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum number of results returned" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "starting index of the results" }, { "key": "restriction", "value": "{{restriction}}", "disabled": true, "description": "restriction entities must satisfy in the Crowd Query Language" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Searches for entities of entity-type (either 'user' or 'group') with the specified search restriction (see https://developer.atlassian.com/display/CROWDDEV/Crowd+Query+Language)" }, "response": [] }, { "name": "Search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/search", "query": [ { "key": "entity-type", "value": "{{entity-type}}", "disabled": false, "description": "type of the entity to search" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum number of results returned" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "starting index of the results" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Searches for entities of entity-type (either 'user' or 'group') satisfying the given search restriction", "body": { "mode": "raw", "raw": "{\n \"restriction-type\": \"property-search-restriction\",\n \"property\": {\n \"name\": \"email\",\n \"type\": \"STRING\"\n },\n \"matchMode\": \"EXACTLY_MATCHES\",\n \"value\": \"bob@example.net\"\n}" } }, "response": [] } ] }, { "name": "Server Info", "item": [ { "name": "Get server info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/server-info", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns server information" }, "response": [] } ] }, { "name": "Sessions", "item": [ { "name": "Get application sessions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/sessions/application", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "search", "value": "{{search}}", "disabled": true, "description": "the search keyword for sessions filtering" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the sessions of applications for specified parameters" }, "response": [] }, { "name": "Get user sessions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/sessions/user", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" }, { "key": "search", "value": "{{search}}", "disabled": true, "description": "the search keyword for sessions filtering" }, { "key": "directoryId", "value": "{{directoryId}}", "disabled": true, "description": "the id of directory for sessions filtering" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the sessions of applications for specified parameters" }, "response": [] }, { "name": "Expire session", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/sessions/:randomHash", "query": [], "variable": [ { "key": "randomHash", "value": "{{randomHash}}", "description": "the randomHash of a session to expire", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Expires the session with given ID" }, "response": [] } ] }, { "name": "Token", "item": [ { "name": "Authenticate user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/session", "query": [ { "key": "validate-password", "value": "{{validate-password}}", "disabled": true, "description": "true if the password should be validated (optional, defaults to true)" }, { "key": "duration", "value": "{{duration}}", "disabled": true, "description": "requested duration of the token, in seconds (optional, defaults to server session duration)" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create new session token valid for duration seconds, or for the server default session timeout if no duration is specified or if duration is longer than the server default session timeout. Either the user password needs to be valid or the 'validate-password' query param must be set to false. If an ongoing session already exists for the same authentication credentials and validation factors, then that session token is returned", "body": { "mode": "raw", "raw": "{\n \"userName\": \"my_username\",\n \"password\": \"my_password\",\n \"validation-factors\": {\n \"validation-factor\": [\n {\n \"name\": \"remote_address\",\n \"value\": \"127.0.0.1\"\n }\n ]\n }\n}" } }, "response": [] }, { "name": "Delete user tokens", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/session", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "the user for which the tokens will be invalidated" }, { "key": "exclude", "value": "{{exclude}}", "disabled": true, "description": "the token to exclude" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Invalidate all tokens for a given user name. Optionally, a token key can be saved from invalidation if specified in the 'exclude' param" }, "response": [] }, { "name": "Get session", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/session/:token", "query": [], "variable": [ { "key": "token", "value": "{{token}}", "description": "the token to retrieve", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the token with the authenticated user expanded" }, "response": [] }, { "name": "Validate token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/session/:token", "query": [], "variable": [ { "key": "token", "value": "{{token}}", "description": "Crowd SSO token", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Validates the session token. Validating the token keeps the SSO session alive", "body": { "mode": "raw", "raw": "{\n \"validation-factor\": [\n {\n \"name\": \"remote_address\",\n \"value\": \"127.0.0.1\"\n }\n ]\n}" } }, "response": [] }, { "name": "Invalidate token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/session/:token", "query": [], "variable": [ { "key": "token", "value": "{{token}}", "description": "the token to invalidate", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Invalidates the Crowd SSO token" }, "response": [] } ] }, { "name": "User Admin", "item": [ { "name": "Search users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/users/search", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "starting index of results returned from the name" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "maximum number of results returned from the name" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns users that can be assigned by to any group administered by the current user", "body": { "mode": "raw", "raw": "{\n \"search\": \"username\",\n \"directoryIds\": [\n 1900\n ],\n \"active\": true,\n \"avatarSizeHint\": 128\n}" } }, "response": [] }, { "name": "Add user to group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/users/:userId/groups", "query": [], "variable": [ { "key": "userId", "value": "{{userId}}", "description": "the user's unique identifier", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds single user to multiple groups placed in the same directory", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"1900-dXNlcjE\",\n \"1900-dXNlcjI\",\n \"1900-dXNlcjM\"\n ]\n}" } }, "response": [] }, { "name": "Remove user from group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/admin/1.0/users/:userId/groups", "query": [], "variable": [ { "key": "userId", "value": "{{userId}}", "description": "the user's unique identifier", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Removes multiple users from single group placed in the same directory", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"1900-dXNlcjE\",\n \"1900-dXNlcjI\",\n \"1900-dXNlcjM\"\n ]\n}" } }, "response": [] } ] }, { "name": "User Authentication", "item": [ { "name": "Authenticate user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/authentication", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "username used for logging" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Authenticates a user. Does not generate an SSO token. For SSO please take a look at the SSO token resource", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"value\": \"hunter2\"\n}" } }, "response": [] }, { "name": "Notify user authenticated", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/authentication/notify", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "username used for logging" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Notifies Crowd that a user has logged into an application, using a method different than the default /authentication or /session resources. Does not initiate a SSO session. This allows to trigger side effects in Crowd, such as updating the user from the remote directory, or applying automatic group assignments" }, "response": [] } ] }, { "name": "Users", "item": [ { "name": "Get user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "name of the user" }, { "key": "key", "value": "{{key}}", "disabled": true, "description": "the key of the user (only observed if userName is null)" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves user details. Either username or key query parameter must be present. The 'expand' parameter can be used to include additional data in the response. This can currently be set to 'attributes', to include the user's attributes in the response" }, "response": [] }, { "name": "Update user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "name of the user to update" } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates a user", "body": { "mode": "raw", "raw": "\"{\\n \\\"name\\\" : \\\"sampleuser\\\",\\n \\\"firstName\\\" : \\\"Sample\\\",\\n \\\"lastName\\\" : \\\"User\\\",\\n \\\"displayName\\\" : \\\"Sample User\\\",\\n \\\"active\\\" : true,\\n \\\"attributes\\\" : null,\\n \\\"email\\\" : \\\"sample@user.cool\\\",\\n}\\n\"" } }, "response": [] }, { "name": "Add user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new user", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"name\": \"sampleuser\",\n \"firstName\": \"Sample\",\n \"lastName\": \"User\",\n \"displayName\": \"Sample User\",\n \"directoryId\": null,\n \"password\": {\n \"link\": null,\n \"value\": \"secret\"\n },\n \"encryptedPassword\": null,\n \"key\": null,\n \"createdDate\": null,\n \"updatedDate\": null,\n \"directoryName\": null,\n \"active\": true,\n \"attributes\": null,\n \"email\": \"sample@user.cool\",\n \"expanded\": true\n}" } }, "response": [] }, { "name": "Remove user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "name of the user to remove" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Removes a user" }, "response": [] }, { "name": "Get user attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/attribute", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "name of the user" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of user attributes" }, "response": [] }, { "name": "Add user attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/attribute", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "name of the user" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Stores the user attributes. Attribute values will not be overwritten if not specified in attributes", "body": { "mode": "raw", "raw": "{\n \"attribute\": [\n {\n \"name\": \"invalidPasswordAttempts\",\n \"values\": [\n \"0\"\n ]\n },\n {\n \"name\": \"requiresPasswordChange\",\n \"values\": [\n \"false\"\n ]\n }\n ]\n}" } }, "response": [] }, { "name": "Delete user attribute", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/attribute", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "name of the user" }, { "key": "attributename", "value": "{{attributename}}", "disabled": false, "description": "name of the attribute to delete" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a user attribute" }, "response": [] }, { "name": "Get user avatar", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/avatar", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "name of the user" }, { "key": "s", "value": "{{s}}", "disabled": true, "description": "the requested avatar size in pixels" } ], "variable": [] }, "method": "GET", "header": [], "description": "Returns the url of the user's avatar" }, "response": [] }, { "name": "Expire all passwords", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/expire-all-passwords", "query": [ { "key": "confirm", "value": "{{confirm}}", "disabled": false, "description": "must be true to take the action. This is so all passwords cannot accidentally be expired" } ], "variable": [] }, "method": "POST", "header": [], "description": "Expires all passwords for all directories which are part of this application, regardless of group mapping" }, "response": [] }, { "name": "Get direct groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/group/direct", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "name of the user" }, { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "name of the group (optional). If null, then all the groups that the user is a direct member of, are returned" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum number of results to return" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index of the result" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the a list of groups the user is a direct member of" }, "response": [] }, { "name": "Add user to group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/group/direct", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "name of the user" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds a user as a direct member of the group", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Remove user from group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/group/direct", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "name of the user" }, { "key": "groupname", "value": "{{groupname}}", "disabled": false, "description": "name of the group" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Removes a user from a group" }, "response": [] }, { "name": "Get nested group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/group/nested", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "name of the user" }, { "key": "groupname", "value": "{{groupname}}", "disabled": true, "description": "name of the group (optional). If null, then all the groups that the user is a nested member of, are returned" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum number of results to return" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index of the result" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the group that the user is a nested member of" }, "response": [] }, { "name": "Request password reset", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/mail/password", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "the name of the user to request a password reset" } ], "variable": [] }, "method": "POST", "header": [], "description": "Sends the user a password reset link to the user's email address" }, "response": [] }, { "name": "Request usernames reminder", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/mail/usernames", "query": [ { "key": "email", "value": "{{email}}", "disabled": false, "description": "email address of the user" } ], "variable": [] }, "method": "POST", "header": [], "description": "Requests an email to be sent containing usernames associated with the given email address" }, "response": [] }, { "name": "Update user password", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/password", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "the name of the user to update the password for" } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates a user password", "body": { "mode": "raw", "raw": "{\n \"link\": null,\n \"value\": \"hunter2\"\n}" } }, "response": [] }, { "name": "Delete user password", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/password", "query": [ { "key": "username", "value": "{{username}}", "disabled": false, "description": "the name of the user to delete the password for" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a user password. This will prevent the user from logging in using a password" }, "response": [] }, { "name": "Rename user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/usermanagement/1/user/rename", "query": [ { "key": "username", "value": "{{username}}", "disabled": true, "description": "name of the user to rename" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Renames a user", "body": { "mode": "raw", "raw": "{\n \"newName\": \"sampleuser-brandnewname\"\n}" } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "http" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "%7Bbaseurl%7D/rest/" } ] }