Factset · Schema
UserResource
FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch
Properties
| Name | Type | Description |
|---|---|---|
| schemas | array | |
| id | string | |
| externalId | string | |
| userName | string | Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across th |
| name | object | The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the |
| string | Email addresses for the user. The value SHOULD be canonicalized by the service provider, e.g., '[email protected]' instead of '[email protected]'. | |
| phoneNumbers | array | Phone numbers for the User. The value SHOULD be canonicalized by the service provider according to the format specified in RFC 3966, e.g., 'tel:+1-201-555-0123'. Canonical type values of 'main', 'work |
| groups | array | A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated. |
| urn:scim:schemas:extension:FactSet:Core:1.0:User | object | |
| urn:scim:schemas:extension:FactSet:VRS:1.0:User | object | |
| meta | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "UserResource",
"type": "object",
"properties": {
"schemas": {
"type": "array"
},
"id": {
"type": "string"
},
"externalId": {
"type": "string"
},
"userName": {
"type": "string",
"description": "Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users."
},
"name": {
"type": "object",
"description": "The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined."
},
"email": {
"type": "string",
"description": "Email addresses for the user. The value SHOULD be canonicalized by the service provider, e.g., '[email protected]' instead of '[email protected]'."
},
"phoneNumbers": {
"type": "array",
"description": "Phone numbers for the User. The value SHOULD be canonicalized by the service provider according to the format specified in RFC 3966, e.g., 'tel:+1-201-555-0123'. Canonical type values of 'main', 'work', 'mobile', and 'home'."
},
"groups": {
"type": "array",
"description": "A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated."
},
"urn:scim:schemas:extension:FactSet:Core:1.0:User": {
"type": "object"
},
"urn:scim:schemas:extension:FactSet:VRS:1.0:User": {
"type": "object"
},
"meta": {
"type": "object"
}
}
}