Documentation

Class

ApiUsers

ApiUsers(client)

Class corresponding to Aworks ApiUsers Endpoints
Constructor

# new ApiUsers(client)

Endpoint constructor
Parameters:
Name Type Description
client Client
See:
  • [ApiUsers in Awork API Docs](https://openapi.awork.com/#/ApiUsers)

View Source endpoints/ApiUsers.js, line 9

Classes

ApiUsers

Methods

# async create(apiUser) → {Promise.<ApiUser>}

Creates a new API user. Beware: API users will also be returned in the /users response when including archived users.
Parameters:
Name Type Description
apiUser ApiUsersCreateModel The model to create an api user.

View Source endpoints/ApiUsers.js, line 33

Promise.<ApiUser>

# async delete(apiUserId) → {Promise.<void>}

Deletes the API user with the specified id.
Parameters:
Name Type Description
apiUserId String The id of the API user.

View Source endpoints/ApiUsers.js, line 62

Promise.<void>

# async updated(apiUserId, apiUser) → {Promise.<ApiUser>}

Updates the API user with the specified id.
Parameters:
Name Type Description
apiUserId String The id of the API user.
apiUser ApiUsersUpdateModel The model tp update an api user.

View Source endpoints/ApiUsers.js, line 51

Promise.<ApiUser>