Site Users

 Top  Previous  Next

Use these endpoints to perform configuration steps on site users.  Authentication with a site API key is required to use these.

 

For additional information, review the site Users page.

 

Get a Site User

 

Request

Endpoint: /api/get/siteuser/UserID

 

Parameters: none

 

Response

A JSON object with these fields:

 

•UserID

•Name

•Password

•IsInactive true|false

•IsAdmin  true|false

•Validcomps - array of company IDs

•Email

•Email2

•Phone

•Notes

•MFA true|false

•EmailVerified true|false

•Email2Verified true|false

•PhoneVerified true|false

•AllowFrom - array of ip/CIDR addresses this user can connect from

•OIDCUserID - user ID in OIDC provider database, reported as the "subject" in OIDC terms

 

or

 

Error: message

 

 

Put a Site User

 

Request

Endpoint: /api/put/siteuser/UserID

 

Parameters:

•Name

•Password - must meet the site's minimum password strength setting, or set to "!" to auto-generate a password

•IsInactive true|false

•IsAdmin  true|false

•Validcomps - a semicolon delimited list of company IDs this user can work with

•Email

•Email2

•Phone

•Notes

•MFA true|false

•AllowFrom - a semicolon delimited list of ip/CIDR addresses this user can connect from

•OIDCUserID - user ID in OIDC provider database, reported as the "subject" in OIDC terms

 

 

Response

A JSON object representing the new record, or Error: message.

 

 

Delete a Site User

 

Request

Endpoint: /api/delete/siteuser/UserID

 

Parameters: none

 

Response

An empty response or Error: message

 

 

List Site Users

 

Request

EndPoint: /api/list/siteusers

 

Parameters:

•csv|tsv - override response format to one of these, set to any value or simply present

 

Response

 

A JSON object containing objects for each site user.

 

or

 

A comma-separated-values or tab-separated-values list if csv or tsv parameters are supplied.

 

or

 

Error: message