Users

Add a user

Add a user. <br> <b>Required scope(s):</b> administration:write

post/api/v4/f/{firm_id}/users

Request

  • Base URL
    https://live.getsilverfin.com
  • URL
    https://live.getsilverfin.com/api/v4/f/{firm_id}/users
  • Auth
    OAuth 2
    Authorization code: https://live.getsilverfin.com/oauth/authorize
    Token URL: https://live.getsilverfin.com/oauth/token scopes: administration:write

Path parameters

firm_idinteger required

Headers

Acceptstring

Request body multipart/form-data

emailstring required
namestring required
contributorboolean

When contributor flag is set to true, the user will be an internal user.<br> When contributor flag is set to false, the user will be an external user. <br>

send_welcome_mailboolean

boolean

localestring

iso 2-digit country code

staff_accessboolean

When staff_access flag is set to true, the user will have multi-file access enabled.<br> When staff_access is set to to false, then multi-file access will be disabled for this user.<br>

receive_digest_emailsboolean

boolean

email_notifications_frequencystring

Value can either be: digest, immediate, never

sso_connection_idinteger

identifier of the SSO entity in Silverfin

Response

Successful response

idinteger

user_id

namestring
usernamestring
created_atstring
emailstring

Changes

No recorded changes to this operation across all 2 revisions of this API.