Download OpenAPI specification:Download
The fabric Identity API lets you manage users. You can create and update user names and addresses. Users can log in to an application and can change or reset their passwords.
The User endpoints let you create local or guest users, update a user's user name, and get information about a specific user.
Get user details
object (xSiteContext) JSON object containing |
OK
User not found
Internal Server Error
{- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "expiryDate": "2020-04-15T10:08:04.246Z",
- "roles": "customer",
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "phone": [
- {
- "number": "555-123-4567",
- "countryCode": "+91",
- "extenstion": "x-6789",
- "kind": "Mobile"
}
], - "email": "test@mail.com",
- "extra": { },
- "registrationSite": "XXX",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userId": "6169b2d892a5f30009d76480",
- "address": [
- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
], - "provider": [
- {
- "id": "6228f647a257734d91dbb49f",
- "name": "LOCAL",
- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "lastLoginDate": "2020-04-15T10:08:04.246Z"
}
], - "createdAt": "2020-04-15T10:08:04.246Z",
- "updatedAt": "2020-04-15T10:08:04.246Z"
}
Update a user's login user name
object (xSiteContext) JSON object containing |
OK
User not found
Internal Server Error
{- "oldUsername": "user101",
- "newUsername": "user202"
}
{- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "expiryDate": "2020-04-15T10:08:04.246Z",
- "roles": "customer",
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "phone": [
- {
- "number": "555-123-4567",
- "countryCode": "+91",
- "extenstion": "x-6789",
- "kind": "Mobile"
}
], - "email": "test@mail.com",
- "extra": { },
- "registrationSite": "XXX",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userId": "6169b2d892a5f30009d76480",
- "address": [
- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
], - "provider": [
- {
- "id": "6228f647a257734d91dbb49f",
- "name": "LOCAL",
- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "lastLoginDate": "2020-04-15T10:08:04.246Z"
}
], - "createdAt": "2020-04-15T10:08:04.246Z",
- "updatedAt": "2020-04-15T10:08:04.246Z"
}
Create local user
object (xSiteContextCreate) JSON object containing |
object (BaseUser) User details | |
object |
Sign-in response
Bad request
Internal Server Error
{- "user": {
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "phone": [
- {
- "number": "555-123-4567",
- "countryCode": "+91",
- "extenstion": "x-6789",
- "kind": "Mobile"
}
], - "email": "test@mail.com",
- "extra": { }
}, - "provider": {
- "username": "user101",
- "password": "ABC123"
}
}
{- "_id": "596f7557696e2d4d617a616c546f7621",
- "userId": "6169b2d892a5f30009d76480",
- "roles": "customer",
- "name": "Pat E Kake",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userType": "customer",
- "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}
Create guest user
object (xSiteContextCreate) JSON object containing |
object (BaseUser) User details | |
object |
Sign-in response
Bad request
Internal Server Error
{- "user": {
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "phone": [
- {
- "number": "555-123-4567",
- "countryCode": "+91",
- "extenstion": "x-6789",
- "kind": "Mobile"
}
], - "email": "test@mail.com",
- "extra": { }
}, - "provider": {
- "username": "user101",
- "password": "ABC123"
}
}
{- "_id": "596f7557696e2d4d617a616c546f7621",
- "userId": "6169b2d892a5f30009d76480",
- "roles": "customer",
- "name": "Pat E Kake",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userType": "customer",
- "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}
The Address endpoints let you create, delete, and update addresses, as well as get a list of addresses or address information.
List all addresses for specified user
object (xSiteContext) JSON object containing |
OK
No addresses found
Internal Server Error
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
Create address for specified user
object (xSiteContext) JSON object containing |
OK
Bad request
Internal Server Error
{- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com"
}
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
Get specified address for specified user
object (xSiteContext) JSON object containing |
OK
Address not found
Internal Server Error
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
Update specified address for specified user
object (xSiteContext) JSON object containing |
OK
Address not found
Internal Server Error
{- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com"
}
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
Delete specified address for specified user
object (xSiteContext) JSON object containing |
OK
Address not found
Internal Server Error
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
Set default address for specified user
object (xSiteContext) JSON object containing |
OK
Address not found
Internal Server Error
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
Unset default address for specified user
object (xSiteContext) JSON object containing |
OK
Address not found
Internal Server Error
[- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
]
The Auth endpoints let the user log in and change or reset a password. You can also refresh a local user.
Log in local user with password
object (xSiteContext) JSON object containing |
Sign-in response
Local authentication failed
Authentication Failed
{- "username": "user101",
- "password": "ABC123"
}
{- "_id": "596f7557696e2d4d617a616c546f7621",
- "userId": "6169b2d892a5f30009d76480",
- "roles": "customer",
- "name": "Pat E Kake",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userType": "customer",
- "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}
Refresh local user with refresh token
object (xSiteContext) JSON object containing |
Sign-in response
Local authentication failed
Authentication Failed
{- "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}
{- "_id": "596f7557696e2d4d617a616c546f7621",
- "userId": "6169b2d892a5f30009d76480",
- "roles": "customer",
- "name": "Pat E Kake",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userType": "customer",
- "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}
Reset password for specified user
object (xSiteContext) JSON object containing |
OK
Inactive user
User not found
Internal Server Error
{- "username": "user101"
}
{- "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "kind": "RESET_PASSWORD",
- "expiresAt": "2020-04-15T10:08:04.246Z",
- "isRedeemed": true,
- "userId": "6169b2d892a5f30009d76480",
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "email": "test@mail.com"
}
Update user password
Note: This endpoint is called internally by the "change password" endpoint
object (xSiteContext) JSON object containing |
OK
Token expired
Token not found
Internal Server Error
{- "userId": "6169b2d892a5f30009d76480",
- "resetToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "newPassword": "ABC123"
}
{- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "expiryDate": "2020-04-15T10:08:04.246Z",
- "roles": "customer",
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "phone": [
- {
- "number": "555-123-4567",
- "countryCode": "+91",
- "extenstion": "x-6789",
- "kind": "Mobile"
}
], - "email": "test@mail.com",
- "extra": { },
- "registrationSite": "XXX",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userId": "6169b2d892a5f30009d76480",
- "address": [
- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
], - "provider": [
- {
- "id": "6228f647a257734d91dbb49f",
- "name": "LOCAL",
- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "lastLoginDate": "2020-04-15T10:08:04.246Z"
}
], - "createdAt": "2020-04-15T10:08:04.246Z",
- "updatedAt": "2020-04-15T10:08:04.246Z"
}
Change password for signed-in user
Note: Use this endpoint to change a user's password
object (xSiteContext) JSON object containing |
OK
Incorrect password
Internal Server Error
{- "userId": "6169b2d892a5f30009d76480",
- "resetToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
- "newPassword": "ABC123"
}
{- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "expiryDate": "2020-04-15T10:08:04.246Z",
- "roles": "customer",
- "name": {
- "first": "Pat",
- "middle": "E",
- "last": "Kake"
}, - "phone": [
- {
- "number": "555-123-4567",
- "countryCode": "+91",
- "extenstion": "x-6789",
- "kind": "Mobile"
}
], - "email": "test@mail.com",
- "extra": { },
- "registrationSite": "XXX",
- "account": "xxxxxcxxxxxxxxxxxxxx",
- "userId": "6169b2d892a5f30009d76480",
- "address": [
- {
- "attention": "Account Manager",
- "address1": "1234 Main St.",
- "address2": "Suite 710",
- "address3": "Floor 7",
- "city": "Houston",
- "state": "TX",
- "country": "USA",
- "zipCode": 77035,
- "company": "Acme Inc.",
- "kind": "Business",
- "phone": {
- "number": "555-123-4567",
- "kind": "Mobile"
}, - "name": {
- "first": "Pat",
- "last": "Kake"
}, - "email": "test@mail.com",
- "isValidated": true,
- "isDefault": true
}
], - "provider": [
- {
- "id": "6228f647a257734d91dbb49f",
- "name": "LOCAL",
- "isActive": true,
- "registrationDate": "2020-04-15T10:08:04.246Z",
- "lastLoginDate": "2020-04-15T10:08:04.246Z"
}
], - "createdAt": "2020-04-15T10:08:04.246Z",
- "updatedAt": "2020-04-15T10:08:04.246Z"
}