Class UserPropertiesService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties

Hierarchy

CommonHttpService
- UserPropertiesService

Index

Constructors

constructor

Methods

createUserProperty deleteUserProperty getUserProperties getUserProperty updateUserProperty initialize

Constructors

constructor

new UserPropertiesService(getClientInstance): UserPropertiesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns UserPropertiesService
Inherited from CommonHttpService.constructor

Methods

createUserProperty

createUserProperty(params): Promise<void>
Creates a property for a user. For more information about user properties, see [Confluence entity properties] (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level.

Note: the number of properties which could be created per app in a tenant for each user might be restricted by fixed system limits. Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      key: string;
      userId: string;
      userPropertyCreate: UserPropertyCreate;
  }
  - key: string
    The key of the user property.
  - userId: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
  - userPropertyCreate: UserPropertyCreate
    The user property to be created.
Returns Promise<void>
Path
POST /wiki/rest/api/user/{userId}/property/{key} @scopes-current write:user.property:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-post

deleteUserProperty

deleteUserProperty(params): Promise<void>
Deletes a property for the given user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  key: string;
  userId: string;
  }
  - key: string
    The key of the user property.
  - userId: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
Returns Promise<void>
Path
DELETE /wiki/rest/api/user/{userId}/property/{key} @scopes-current write:user.property:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-delete

getUserProperties

getUserProperties(params): Promise<UserPropertyKeyArray>
Returns the properties for a user as list of property keys. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      limit?: number;
      start?: number;
      userId: string;
  }
  - Optionallimit?: number
    The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.
  - Optionalstart?: number
    The starting index of the returned properties.
  - userId: string
    The account ID of the user to be queried for its properties.
Returns Promise<UserPropertyKeyArray>
Returned if the requested properties are returned.

Path
GET /wiki/rest/api/user/{userId}/property @scopes-current read:user.property:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-get

getUserProperty

getUserProperty(params): Promise<UserProperty>
Returns the property corresponding to key for a user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  key: string;
  userId: string;
  }
  - key: string
    The key of the user property.
  - userId: string
    The account ID of the user to be queried for its properties.
Returns Promise<UserProperty>
Returned if the requested properties are returned.

Path
GET /wiki/rest/api/user/{userId}/property/{key} @scopes-current read:user.property:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-get

updateUserProperty

updateUserProperty(params): Promise<void>
Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      key: string;
      userId: string;
      userPropertyUpdate: UserPropertyUpdate;
  }
  - key: string
    The key of the user property.
  - userId: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
  - userPropertyUpdate: UserPropertyUpdate
    The user property to be updated.
Returns Promise<void>
Path
PUT /wiki/rest/api/user/{userId}/property/{key} @scopes-current write:user.property:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class UserPropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns UserPropertiesService

Methods

createUserProperty

Parameters

key: string

userId: string

userPropertyCreate: UserPropertyCreate

Returns Promise<void>

Path

See

deleteUserProperty

Parameters

key: string

userId: string

Returns Promise<void>

Path

See

getUserProperties

Parameters

Optionallimit?: number

Optionalstart?: number

userId: string

Returns Promise<UserPropertyKeyArray>

Path

See

getUserProperty

Parameters

key: string

userId: string

Returns Promise<UserProperty>

Path

See

updateUserProperty

Parameters

key: string

userId: string

userPropertyUpdate: UserPropertyUpdate

Returns Promise<void>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`limit?: number

`Optional`start?: number

`Protected` `Static`initialize