Schema Reference
The application schema is used to configure the objects returned from a connector.
Note
-
The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.
-
The schema attributes that are not present by default must be defined as strings if not specified.
The Gremlin connector uses the following default correlation and object configurations.
Default Account Schema
Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.
The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.
Default Account ID
SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.
Caution
Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
To resolve issues caused by changing account IDs, reconfigure them to their default values.
The following table lists the default account IDs for this connector:
| Account ID | Schema Object Type |
|---|---|
| identifier | Account |
Default Account Attributes
The Gremlin connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.
| Attribute Name | Description |
|---|---|
| identifier | Unique identifier (Email) of the user within Gremlin |
| state | Current status of the user's account, such as active, invited, or revoked |
| first_name | First name of the Gremlin user |
| last_name | Last name of the Gremlin user |
| created_at | Timestamp when the user account was created in Gremlin |
| updated_at | Timestamp when the user account was last updated |
| default_company_role | The company role assigned to the user by default, granting privileges for actions performed outside of a team, such as managing company settings or users |
| company_roles | Company role or roles assigned to the user, granting privileges for company-wide actions such as managing users, teams, integrations, and security settings |
| hashed_identifier | A hashed representation of the user's identifier, used to reference the user internally without exposing the raw identifier |
| last_login | Timestamp of the user's most recent login to Gremlin |
| last_auth_type | The authentication method used during the user's last login, such as password, SSO/SAML, or OAuth |
| team_identifier | Identifier or identifiers of the teams the user belongs to, granting team-level privileges such as running experiments or managing clients |
Default Entitlement Attributes
Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to Managing Entitlements for more information.
Caution
Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.
Default Role Attributes
The Gremlin connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.
| Attribute Name | Description |
|---|---|
| key | Unique identifier (key) of the company role |
| name | Display name of the company role, such as Company Owner, Company Manager, or Company User |
| description | Human-readable explanation of the privileges granted by the company role |
| type | Category of the role, indicating it is a company-level role rather than a team-level role |
| privileges | List of privileges granted by the role, such as COMPANY_USERS_READ or ROLES_WRITE, which determine the actions a user assigned to this role can perform outside of a team |
Default Team Attributes
The Gremlin connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
| Attribute Name | Description |
|---|---|
| team_identifier | Unique Identifier (UUID) of the team within Gremlin |
| name | Display name of the team |
| state | Current status of the team, such as active or deleted |
| created_at | Timestamp when the team was created |
| default_team_role | The team role automatically granted to members of the team, determining their default privileges, such as running experiments or managing clients |
| production | Indicates whether the team is designated as a production team, which may apply additional safeguards, such as restricted testing time windows, to experiments run within it |
| pref_autoAddUsers | Team preference indicating whether new company users are automatically added to this team |
| pref_domain | Team preference specifying the email domain used to automatically add matching users to the team |