This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit user.edit
user.edit
user.edit
API Method: user.edit
API Method: user.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Description
Transaction Types
Transaction Types
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| disabled | Disable or enable the user. |
| approved | Approve or reject the user. |
| realName | Stores the real name of the user, like "Abraham Lincoln". |
| title | User title, like "CEO" or "Assistant to the Manager". |
| icon | User icon to accompany their title. |
| blurb | Short blurb about the user. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: disabled
Transaction Type: disabled
Disable or enable the user.
| Key | Type | Description |
|---|---|---|
| type | const | disabled |
| value | bool | True to disable the user. |
Transaction Type: approved
Transaction Type: approved
Approve or reject the user.
| Key | Type | Description |
|---|---|---|
| type | const | approved |
| value | bool | True to approve the user. |
Transaction Type: realName
Transaction Type: realName
Stores the real name of the user, like "Abraham Lincoln".
| Key | Type | Description |
|---|---|---|
| type | const | realName |
| value | string |
Transaction Type: title
Transaction Type: title
User title, like "CEO" or "Assistant to the Manager".
| Key | Type | Description |
|---|---|---|
| type | const | title |
| value | string |
Transaction Type: icon
Transaction Type: icon
User icon to accompany their title.
| Key | Type | Description |
|---|---|---|
| type | const | icon |
| value | string |
Transaction Type: blurb
Transaction Type: blurb
Short blurb about the user.
| Key | Type | Description |
|---|---|---|
| type | const | blurb |
| value | string |
Transaction Type: mfa
Transaction Type: mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://collaboration.hexavara.com/ --conduit-token <conduit-token> user.edit
$ curl https://collaboration.hexavara.com/api/user.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/libphutil/src/__phutil_library_init__.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://collaboration.hexavara.com/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('user.edit', $api_parameters);
print_r($result);