JSON schema
JSON files used by SaaS generic connector must contain an object with two arrays:
-
Users
-
Subscriptions
User object properties
Name | Type | Description | Required |
---|---|---|---|
Id | string | Unique identifier for a user in the SaaS product. For example, this value can be an internal ID, a UUID, an email address, or a user name. | Yes |
string (email) | Email address for the user. Should be entered even if the Id field is an email address. | No | |
UserName | string | Username, nickname, or alias for a user. | No |
Name | string | Full name (first and last name) of the person who this user account belongs to. | No |
Status | string (enum) | Describes the current status of the user. The following values are supported:
| No |
FirstActivity | string (date - time) | The datetime of the first activity of or related to this user. Format of the property: "2017-08-22T17:22:17" | No |
LastActivity | string (date - time) | The datetime of the last activity of or related to this user. Format of the property: "2019-09-16T17:22:17" | No |
Registration | string (date - time) | The registration or creation datetime of the user. Format of the property: "2017-08-22T17:22:17" | No |
Subscription object properties
Name | Type | Description | Required |
---|---|---|---|
Id | string | ID for the subscription, preferably from the SaaS product. | Yes |
UserCap | int | Maximum number of seats that this subscription supports. If the number of seats is unlimited, enter the following value: 2147483647 This number is the maximum value for a property of Integer Type. | No |
AvailableSeats | int | Available user grants/seats that can be used. If the number of available seats is unlimited, enter the following value: 2147483647 This number is the maximum value for a property of Integer Type. | No |
MeteringTypes | string (enum) | Defines the kind of metering that is used for subscription cost. The following values are supported:
| Yes |
Created | string (date - time) | DateTime when the subscription was created. Format of the property: “2009-06-15T13:45:30” | No |
UserIds | array | List of user IDs that currently consume a product license. Specified values must match a User->ID from the users list. | Yes |
Type | object (SubscriptionType) | Object that contains the ID and Name properties. Defines the subscription type. Can be used for multiple subscriptions in one connector or across more than one connector. | Yes |
Subscription type object properties
note
For best results and representation of data in Snow License Manager, it is recommended to populate the optional fields.
Name | Type | Description | Required |
---|---|---|---|
ID | string | Unique ID for a subscription type. Example:
| Yes |
Name | string | Friendly name for the subscription type. Example:
| Yes |