Conduit user.edit

user.edit

API Method: user.edit

Returns

map<string, wild>

Errors

ERR-CONDUIT-CORE: See error message for details.

OAuth Scope

OAuth clients may never call this method.

Method Description

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.

Transaction Summary

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.

disabled

Disable or enable the user.

Key	Type	Description
type	const	disabled
value	bool	True to disable the user.

approved

Approve or reject the user.

Key	Type	Description
type	const	approved
value	bool	True to approve the user.

realName

Stores the real name of the user, like "Abraham Lincoln".

Key	Type	Description
type	const	realName
value	string

title

User title, like "CEO" or "Assistant to the Manager".

Key	Type	Description
type	const	title
value	string

icon

User icon to accompany their title.

Key	Type	Description
type	const	icon
value	string

blurb

Short blurb about the user.

Key	Type	Description
type	const	blurb
value	string

mfa

Sign this transaction group with MFA.

Key	Type	Description
type	const	mfa
value	bool

Call Method

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://docs.sipthor.net/ --conduit-token <conduit-token> -- user.edit