Skip to main content

User accounts

API docs by Redocly

SAM: User accounts (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with User Accounts.

Get user

Returns the details of a user.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the user for which details will be returned.

Responses

Response samples

Content type
application/json
{
  • "id": "d983ee47-92c9-47ad-9975-ec85d2a479a1",
  • "userName": "ssmith",
  • "status": "Active",
  • "email": "ssmith@thebagel.co",
  • "organizationId": "8b4f2d90-99e7-408a-bad6-68d491e94dba",
  • "fullName": "Sammy Smith",
  • "phoneNumber": "789-654-1236",
  • "location": "Austin",
  • "roomNumber": "5716",
  • "quarantineDate": "2019-08-24T14:15:22Z",
  • "lastLogon": "2019-08-24T14:15:22Z",
  • "lastUpdate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "Data Update Job",
  • "_links": [
    ]
}

Get users

Returns a collection of users.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

Filter the collection of Users. Format of the query string parameter:

<filter name> <operator>  -<value>
Filter name Description Data type Example
userName The userName of a user String ?filter=userName -eq "Sammy"
status The status of a user String ?filter=status -ne "active"
fullName The fullName of a user String ?filter=fullName -contains "Sammy"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get user discovery data

Returns discovery data for a given user.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the user account for which details will be returned.

Responses

Response samples

Content type
application/json
{
  • "objectId": "",
  • "domainName": "thebagel",
  • "samAccountName": "thebagel\\ssmith",
  • "firstName": "Sammy",
  • "lastName": "Smith",
  • "email": "ssmith@thebegel.co",
  • "homePhoneNumber": "789-654-1236",
  • "mobilePhoneNumber": "",
  • "lastLogonActivity": "2019-08-24T14:15:22Z",
  • "whenCreated": "2019-08-24T14:15:22Z",
  • "whenChanged": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "userAccountControl": 0,
  • "managerName": "Billy Hare",
  • "managerEmail": "bhare@thebagel.co",
  • "organizationalUnit": "Laurel_MI",
  • "userPrincipalName": "ssmith@thebegel.co",
  • "_links": [
    ]
}

Get users discovery data

Returns a collection of discovery data for users.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string
Example: filter=domainName -eq "thebagel.co"

Filter the collection of user discovery details. Format of the query string parameter:

<filter name> <operator>  -<value>
Filter name Description Data type Example
domainName The domainName for users String ?filter=domainName -eq "thebagel.co"
samAccountName The samAccountName of a user String ?filter=samAccountName -eq "thebagel\ssmith"
email The email of a user String ?filter=email -eq "ssmith@thebagel.co"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get users metering data

Returns a collection of metering data for users.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string
Example: filter=applicationID -eq "85d5dc09-115c-40db-a2f6-09f9c935852e"

Filter the collection account metering. Format of the query string parameter:

<filter name> <operator>  -<value>
Filter name Description Data type Example
metricID The user accounts metricID String ?filter=metricID -eq "2823fbea-bd7b-4f4f-9f0c-780a5f26218c"
applicationID The user accounts applicationID String ?filter=applicationID -eq "85d5dc09-115c-40db-a2f6-09f9c935852e"
organizationID The user accounts organizationID String ?filter=organizationID -eq"317db6a5-e16d-4e3b-a745-1f973690e982"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get user metering data

Returns metering data for a given user.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the user for which details will be returned.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string
Example: filter=applicationID -eq "85d5dc09-115c-40db-a2f6-09f9c935852e"

Filter the collection account metering. Format of the query string parameter:

<filter name> <operator>  -<value>
Filter name Description Data type Example
metricID The user accounts metricID String ?filter=metricID -eq "2823fbea-bd7b-4f4f-9f0c-780a5f26218c"
applicationID The user accounts applicationID String ?filter=applicationID -eq "85d5dc09-115c-40db-a2f6-09f9c935852e"
organizationID The user accounts organizationID String ?filter=organizationID -eq"317db6a5-e16d-4e3b-a745-1f973690e982"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}