Users: List of Tasks

You can perform the following tasks using the Users resource:

Task Task Type URI Description

Get users

GET

/rest/ofscCore/v1/users

This operation returns a list of users who are visible to the user.

The resources that are returned are based on the users resource association.

If the user is assigned to the top level of the resource tree, all resources are visible and returned in the response.

If the user is assigned to a lower level in the resource tree, the response returns resources only for that portion of the resource tree.

Create user

PUT

/rest/ofscCore/v1/users/{login}

This operation creates a new user.

When creating a new user:
  • The user login must be unique.
  • The user must be assigned to one or more resources.
  • The user must be assigned to a user type.

If the user timeZone isn't specified, the user inherits the TimeZone assigned to the Parent in the Resource tree.

Delete user

DELETE

/rest/ofscCore/v1/users/{login}

This operation deletes the specified user account.

Get user

GET

/rest/ofscCore/v1/users/{login}

This operation retrieves the details of the specified user account.

Update user

PATCH

/rest/ofscCore/v1/users/{login}

This operation updates the properties of the specified user account.

Delete file property

DELETE

/rest/ofscCore/v1/users/{login}/{propertyLabel}

This operation deletes the specified 'file' property for the specific user.

Get file property

GET

/rest/ofscCore/v1/users/{login}/{propertyLabel}

This operation gets the specified 'file' property for the specific user.

You can resume an incomplete download by identifying the offset in the range header.

For example, ""Range: bytes=1000-"" means that downloading starts from offset 1000 bytes up to the end of the file.

Set file property

PUT

/rest/ofscCore/v1/users/{login}/{propertyLabel}

This operation creates the specified 'file' property for the specific user.

Add collaboration groups

POST

/rest/ofscCore/v1/users/{login}/collaborationGroups

This operation creates collaboration groups for the specified user.

Delete collaboration groups

DELETE

/rest/ofscCore/v1/users/{login}/collaborationGroups

This operation deletes all the assigned collaboration groups for the specified user.

Get collaboration groups

GET

/rest/ofscCore/v1/users/{login}/collaborationGroups

This operation returns a list of the collaboration groups associated with the specified user.