Confluence v1 Users and Groups API — groups, group members, users, and user properties.
Confluence v1 Users and Groups API — groups, group members, users, and user properties.
(add-user-to-group-by-group-id client group-id body)(add-user-to-group-by-group-id client group-id body opts)Add member to group by groupId. POST /wiki/rest/api/group/userByGroupId Required query param: :groupId. Body: AccountId — {:accountId string}
Add member to group by groupId.
POST /wiki/rest/api/group/userByGroupId
Required query param: :groupId.
Body: AccountId — {:accountId string}(create-group client body)(create-group client body opts)Create new user group. POST /wiki/rest/api/group Body: GroupName — {:name string}
Create new user group.
POST /wiki/rest/api/group
Body: GroupName — {:name string}(create-user-property client user-id key body)Create user property by key. POST /wiki/rest/api/user/{userId}/property/{key} Path params: userId, key Body: UserPropertyCreate — {:value object}
Create user property by key.
POST /wiki/rest/api/user/{userId}/property/{key}
Path params: userId, key
Body: UserPropertyCreate — {:value object}(delete-user-property client user-id key)Delete user property. DELETE /wiki/rest/api/user/{userId}/property/{key} Path params: userId, key
Delete user property.
DELETE /wiki/rest/api/user/{userId}/property/{key}
Path params: userId, key(get-anonymous-user client)(get-anonymous-user client opts)Get anonymous user. GET /wiki/rest/api/user/anonymous Optional query params: :expand
Get anonymous user. GET /wiki/rest/api/user/anonymous Optional query params: :expand
(get-bulk-user-lookup client account-id)(get-bulk-user-lookup client account-id opts)Get multiple users using ids. GET /wiki/rest/api/user/bulk Required query param: :accountId (list of account IDs). Optional: :expand
Get multiple users using ids. GET /wiki/rest/api/user/bulk Required query param: :accountId (list of account IDs). Optional: :expand
(get-current-user client)(get-current-user client opts)Get current user. GET /wiki/rest/api/user/current Optional query params: :expand
Get current user. GET /wiki/rest/api/user/current Optional query params: :expand
(get-group-by-group-id client id)(get-group-by-group-id client id opts)Get group. GET /wiki/rest/api/group/by-id Required query param: :id (the id of the group)
Get group. GET /wiki/rest/api/group/by-id Required query param: :id (the id of the group)
(get-group-members-by-group-id client group-id)(get-group-members-by-group-id client group-id opts)Get group members. GET /wiki/rest/api/group/{groupId}/membersByGroupId Path params: groupId Optional query params: :start, :limit, :shouldReturnTotalSize, :expand
Get group members.
GET /wiki/rest/api/group/{groupId}/membersByGroupId
Path params: groupId
Optional query params: :start, :limit, :shouldReturnTotalSize, :expand(get-group-memberships-for-user client account-id)(get-group-memberships-for-user client account-id opts)Get group memberships for user. GET /wiki/rest/api/user/memberof Required query param: :accountId. Optional: :start, :limit
Get group memberships for user. GET /wiki/rest/api/user/memberof Required query param: :accountId. Optional: :start, :limit
(get-groups client)(get-groups client opts)Get groups. GET /wiki/rest/api/group Optional query params: :start, :limit, :accessType
Get groups. GET /wiki/rest/api/group Optional query params: :start, :limit, :accessType
(get-privacy-unsafe-user-email client account-id)Get user email address. GET /wiki/rest/api/user/email Required query param: :accountId
Get user email address. GET /wiki/rest/api/user/email Required query param: :accountId
(get-privacy-unsafe-user-email-bulk client account-id)Get user email addresses in batch. GET /wiki/rest/api/user/email/bulk Required query param: :accountId (array of account IDs)
Get user email addresses in batch. GET /wiki/rest/api/user/email/bulk Required query param: :accountId (array of account IDs)
(get-user client account-id)(get-user client account-id opts)Get user. GET /wiki/rest/api/user Required query param: :accountId. Optional: :expand
Get user. GET /wiki/rest/api/user Required query param: :accountId. Optional: :expand
(get-user-properties client user-id)(get-user-properties client user-id opts)Get user properties. GET /wiki/rest/api/user/{userId}/property Path params: userId Optional query params: :start, :limit
Get user properties.
GET /wiki/rest/api/user/{userId}/property
Path params: userId
Optional query params: :start, :limit(get-user-property client user-id key)Get user property. GET /wiki/rest/api/user/{userId}/property/{key} Path params: userId, key
Get user property.
GET /wiki/rest/api/user/{userId}/property/{key}
Path params: userId, key(remove-group-by-id client id)(remove-group-by-id client id opts)Delete user group. DELETE /wiki/rest/api/group/by-id Required query param: :id (group id to delete)
Delete user group. DELETE /wiki/rest/api/group/by-id Required query param: :id (group id to delete)
(remove-member-from-group-by-group-id client group-id account-id)(remove-member-from-group-by-group-id client group-id account-id opts)Remove member from group using group id. DELETE /wiki/rest/api/group/userByGroupId Required query params: :groupId, :accountId
Remove member from group using group id. DELETE /wiki/rest/api/group/userByGroupId Required query params: :groupId, :accountId
(search-groups client query-str)(search-groups client query-str opts)Search groups by partial query. GET /wiki/rest/api/group/picker Required query param: :query (search term). Optional: :start, :limit, :shouldReturnTotalSize
Search groups by partial query. GET /wiki/rest/api/group/picker Required query param: :query (search term). Optional: :start, :limit, :shouldReturnTotalSize
(update-user-property client user-id key body)Update user property. PUT /wiki/rest/api/user/{userId}/property/{key} Path params: userId, key Body: UserPropertyUpdate — {:value object}
Update user property.
PUT /wiki/rest/api/user/{userId}/property/{key}
Path params: userId, key
Body: UserPropertyUpdate — {:value object}cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |