User
version : 0.0.0
stability : stable
Objects
User
Fields
| Name | Type | Description |
|---|---|---|
| account | Account | Find an account by its login that the user belongs to. |
| id | ID! | The user's identifier. |
| login | String! | The user's login name. |
| name | String | The user's public profile name. (This field will be replaced by `firstName` and `lastName` and will be no longer available from 2021/06/02) |
| firstName | String | The user's public profile first name. |
| lastName | String | The user's public profile last name. |
| organization | Organization | Find an organization by its login that the user belongs to. |
| accountPermission | Permission | The permission level of the user inside the account. |
| organizationPermission | Permission | The permission level of the user inside the organization. |
| userType | UserType | The user's platform type (Frontend or API) |
| jobTitle | String | The user's job title. |
UserEdge
Fields
| Name | Type | Description |
|---|---|---|
| cursor | ID! | - |
| node | User | - |
PageInfo
Information about type pagination in a connection. Fields
| Name | Type | Description |
|---|---|---|
| startCursor | ID | When paginating backwards, the cursor to continue. |
| endCursor | ID | When paginating forwards, the cursor to continue. |
| hasNextPage | Boolean! | When paginating forwards, are there more items? |
| hasPreviousPage | Boolean! | When paginating backwards, are there more items? |
UserConnection
Fields
| Name | Type | Description |
|---|---|---|
| edges | [UserEdge]! | - |
| nodes | [User]! | - |
| pageInfo | PageInfo! | - |
Queries
user
Returns: User
Arguments
| Name | Type | Description |
|---|---|---|
| login | String! | - |
users
Returns: UserConnection
Arguments
| Name | Type | Description |
|---|---|---|
| first | Int! | - |
| after | String | - |
Mutations
createUser
Returns: User
Arguments
| Name | Type | Description |
|---|---|---|
| input | CreateUserMutationInput! | - |
updateUser
Returns: User
Arguments
| Name | Type | Description |
|---|---|---|
| input | UpdateUserMutationInput! | - |
deleteUser
Returns: User
Arguments
| Name | Type | Description |
|---|---|---|
| input | DeleteUserMutationInput! | - |
Inputs
CreateUserMutationInput
Fields
| Name | Type | Description | Default |
|---|---|---|---|
| account | ConstraintString | The account of the user. | - |
| name | ConstraintString | The user's public profile name. (This field will be replaced by `firstName` and `lastName` and will be no longer available from 2021/06/02) | - |
| firstName | ConstraintString | The user's public profile first name. | - |
| lastName | ConstraintString | The user's public profile last name. | - |
| ConstraintString | The user's email. | - | |
| accountPermission | Permission | The permission level of the user inside the account. | - |
| organizationPermission | Permission | The permission level of the user inside the organization. | - |
| userType | UserType | The user's platform type (Frontend or API) | - |
| jobTitle | ConstraintString | The user's job title. | - |
UpdateUserMutationInput
Fields
| Name | Type | Description | Default |
|---|---|---|---|
| account | ConstraintString | The account of the user. | - |
| login | ConstraintString | The user's login name. | - |
| name | ConstraintString | The user's public name. (This field will be replaced by `firstName` and `lastName` and will be no longer available from 2021/06/02) | - |
| firstName | ConstraintString | The user's public profile first name. | - |
| lastName | ConstraintString | The user's public profile last name. | - |
| accountPermission | Permission | The permission level of the user inside the account. | - |
| organizationPermission | Permission | The permission level of the user inside the organization. | - |
| jobTitle | ConstraintString | The user's job title. | - |
DeleteUserMutationInput
Fields
| Name | Type | Description | Default |
|---|---|---|---|
| login | ConstraintString | - | - |
| account | ConstraintString | The account of the user. | - |