User resource
/User
Dictionary table
The diagram service model of the object: http:https://www.download.soffid.org/com/doc/console/latest/uml/com/soffid/iam/api/User.html
Soffid allows you to add customized data to the user object. You can do that on metadata, on the proper object.
Query schema
It is allowed to consult all the User definition using the Schema query:
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.UserResponse 200 OK
{
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.User",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "User",
"description": "User object",
"attributes": [
{
"subattributes": [
{
"uniqueness": "none",
"name": "NIF",
"description": "NIF",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "PHONE",
"description": "PHONE",
"canonicalValues": [
"1",
"2",
"3"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "manager",
"description": "Manager",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "Contrat_type",
"description": "Contract type",
"canonicalValues": [
"T",
"I",
"F",
"S"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "RegisterServiceProvider",
"description": "RegisterServiceProvider",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "EMAIL",
"description": "External email",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "ActivationKey",
"description": "ActivationKey",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "picture",
"description": "Fotografía",
"mutability": "readWrite",
"type": "binary",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "birthDate",
"description": "Birth date",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "language",
"description": "Languages spoken by the user",
"canonicalValues": [
"Spanish",
"English",
"German"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "country",
"description": "Country",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"uniqueness": "none",
"name": "attributes",
"description": "Custom attributes",
"mutability": "readWrite",
"type": "complex",
"returned": "default",
"multiValued": false
},
{
"uniqueness": "none",
"name": "userName",
"description": "User name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "firstName",
"description": "First name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "lastName",
"description": "Last Name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "middleName",
"description": "Middle name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "fullName",
"description": "Full name",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "userType",
"description": "Type",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "primaryGroup",
"description": "Primary group",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "homeServer",
"description": "Home server",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "profileServer",
"description": "Profile server",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "emailAddress",
"description": "Internal eMail",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mailAlias",
"description": "Mail alias",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mailServer",
"description": "Mail server",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "active",
"description": "Enabled",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "multiSession",
"description": "Multi session",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "comments",
"description": "Comments",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdByUser",
"description": "Created by",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdDate",
"description": "Created on",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "modifiedByUser",
"description": "Modifid by",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "modifiedDate",
"description": "Modified last on",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"subattributes": [
{
"uniqueness": "none",
"name": "domain",
"description": "Password domain to be changed. By default, the DEFAULT domain is changed",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "value",
"description": "The password itself, in clear text",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "expired",
"description": "If not set to false, the user will be prompted to change it on next logon",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"multiValued": false,
"required": false
}
],
"uniqueness": "none",
"name": "password",
"description": "Change current user password",
"mutability": "writeOnly",
"type": "complex",
"caseExact": true,
"multiValued": true,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.api.User"
}Full JSON example
Visit SCIM User examples page