User /user/{user-id}

Represents an individual user.

Reading

GET /user/{user-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with workspace_users permission is required.
  • If access token points to an user, the user must be attached to the workspace at which is attached the current person.
  • If access token points to a workspace, the user must be attached to the current workspace.

Fields

Name Description Type

_id

The user ID.

string

first_name

The first name of the user.

string

last_name

The last name of the user.

string

job

The job of the user.

string

organisation

The ID of the Organisation of the user.

Organisation

avatar

The ID of the Photo that represents the avatar of the user.

Photo

mails

The mail addresses of the user.

object[]

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

phones

The phone numbers of the user.

object[]

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

addresses

The postal addresses of the user.

object[]

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

environment

The environment of the user.

object[]

workspace

The ID of the Workspace at which is attached the user.

Workspace

apps

An array of App IDs at which the user has access.

App[]

options

An array of Option IDs at which the user has access.

Option[]

created_time

The date that indicates when the user was created.

date

updated_time

The date that indicates when the user was updated for the last time.

date

Computed fields

Name Description Type

name

The name of the user.
Made by concat first_name field and last_name field.

string

main_mail

The main mail address of the user.
Taken from mails field (item whose its main field is set to true).

object

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

main_phones

The main phone number of the user.
Taken from phones field (item whose its main field is set to true).

object

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

main_addresses

The main postal address of the user.
Taken from addresses field (item whose its main field is set to true).

object

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

Publishing

You can't create users by using the Nexty API. Please contact us if you want to add a new user to your Nexty Platform.

Updating

PUT /user/{user-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token (pointing to an user) with manage_users permission is required.
  • At least one of the following criteria must be met :
    • The user is the current person.
    • The current person is an admin (with MANAGE permission) of the workspace at witch is attached the user.

Fields

Name Description Type

first_name

The first name of the user.

string

last_name

The last name of the user.

string

job

The job of the user.

string

avatar

The ID of the Photo that represents the avatar of the user.
Must be a photo attached to the user or a photo owned by the current person whose its tmp field is set to true.

Photo

mails

The mail addresses of the user.

object[]

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

phones

The phone numbers of the user.

object[]

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

addresses

The postal addresses of the user.

object[]

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Deleting

You can't delete users by using the Nexty API. Please contact us if you want to remove an user from your Nexty Platform.

Edges

Name Description

/accounts

The accounts attached to the user.

/contacts

The contacts attached to the user.

/feed

The feed of the user.

/groups

The groups at which is attached the user.

/permissions

The permissions that the thirdparty has requested from the user.

/photos

The photos attached to the user.