finsit API - User

A collection of help pages for using the API.

User

URL /Api/v2/User/{userName}
Accepted verbs GET, POST, PUT, DELETE
Description

Provides methods to get or manage user accounts.

GET /Api/v2/User?agencyId={agencyId}

Get a list of all users that are available for the current user account to access.

Parameters
NameDescriptionAdditional information
agencyId Specifies the agency whose users will be included in the response.

URI parameter

Returns

The requested list of UserInfo.

GET /Api/v2/User/{userName}

Get a particular user by its username.

Parameters
NameDescriptionAdditional information
userName Username of the user to fetch.

URI parameter

Returns

The requested UserInfo.

POST /Api/v2/User

Create a new user.

Parameters
NameDescriptionAdditional information
apiUserInfo The new UserInfo to create.

Body data

Returns

The newly created UserInfo.

PUT /Api/v2/User

Update an existing user.

Parameters
NameDescriptionAdditional information
apiUserInfo Updated UserInfo information.

Body data

Returns

The UserInfo with updated information.

DELETE /Api/v2/User/{userName}

Delete an user.

Parameters
NameDescriptionAdditional information
userName Username of the user to delete.

URI parameter