> ## Documentation Index
> Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt
> Use this file to discover all available pages before exploring further.
# Get user
> Get user details
## OpenAPI
````yaml identity_v1 get /api-commerceIdentity/user/{userId}
openapi: 3.0.1
info:
title: Authentication v1
description: >-
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.
version: 1.0.0
contact:
email: support@fabric.inc
license:
name: fabric API License
url: https://fabric.inc/api-license
servers:
- url: https://{customerDomain}.fabric.zone
variables:
customerDomain:
default: demo
security: []
tags:
- name: User
description: >-
The User endpoints let you create local or guest users, update a user's
user name, and get information about a specific user.
- name: Address
description: >-
The Address endpoints let you create, delete, and update addresses, as
well as get a list of addresses or address information.
- name: Auth
description: >-
The Auth endpoints let the user log in and change or reset a password. You
can also refresh a local user.
paths:
/api-commerceIdentity/user/{userId}:
parameters:
- $ref: '#/components/parameters/xSiteContent'
- name: userId
in: path
description: User ID
required: true
schema:
type: string
example: 6169b2d892a5f30009d76480
get:
tags:
- User
summary: Get user
description: Get user details
operationId: getUser
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'404':
$ref: '#/components/responses/user-not-found'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
components:
parameters:
xSiteContent:
name: x-site-context
in: header
description: >-
The `x-site-context` header is a JSON object that contains information
about the source you wish to pull from. The mandatory `account` is the
24 character identifier found in Copilot. The `channel` (Sales channel
ID), `stage` (environment name), and `date` attributes can be used to
further narrow the scope of your data source.
required: true
schema:
type: string
example: >-
{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account":
"1234abcd5678efgh9ijklmno","stage":"production"}
schemas:
User:
description: User
allOf:
- type: object
properties:
isActive:
description: 'true: User is active
false: User is not active'
type: boolean
example: true
registrationDate:
description: Time user was registered
type: string
format: date-time
example: '2020-04-15T10:08:04.246Z'
expiryDate:
description: Time user's registration expires
type: string
format: date-time
example: '2020-04-15T10:08:04.246Z'
roles:
description: User roles
type: array
example: customer
items:
type: string
- $ref: '#/components/schemas/BaseUser'
- type: object
properties:
registrationSite:
description: XXX
type: string
example: XXX
account:
description: Merchant account ID
type: string
example: xxxxxcxxxxxxxxxxxxxx
userId:
description: User ID
type: string
example: 6169b2d892a5f30009d76480
address:
description: User address
type: array
items:
$ref: '#/components/schemas/Address'
provider:
description: Additional user details
type: array
items:
$ref: '#/components/schemas/Provider'
createdAt:
description: Time user was created
type: string
format: date-time
example: '2020-04-15T10:08:04.246Z'
updatedAt:
description: Time user was last updated
type: string
format: date-time
example: '2020-04-15T10:08:04.246Z'
BaseUser:
description: User details
type: object
properties:
name:
description: User's full name
type: object
properties:
first:
description: User's first name
type: string
example: Pat
middle:
description: User's middle name
type: string
example: E
last:
description: User's last name
type: string
example: Kake
phone:
description: User's telephone numbers and details
type: array
items:
type: object
properties:
number:
description: Telephone number
type: string
example: 555-123-4567
countryCode:
description: Telephone country code
type: string
example: '+91'
extenstion:
description: Telephone number extension
type: string
example: x-6789
kind:
description: Phone type
type: string
example: Mobile
email:
description: User's email address
type: string
example: test@mail.com
extra:
description: Extra user details
type: object
additionalProperties: true
Address:
description: Address
required:
- address1
- city
- state
- country
- zipCode
- email
- isDefault
- isValidated
allOf:
- $ref: '#/components/schemas/BaseAddress'
- type: object
properties:
isValidated:
description: >-
true: Address has been validated
false: Address has not
been validated
type: boolean
example: true
isDefault:
description: >-
true: This is the default address
false: This is an
additional address
type: boolean
example: true
Provider:
description: Object to store personal details
type: object
properties:
id:
description: Provider ID
type: string
example: 6228f647a257734d91dbb49f
name:
description: Provider name
type: string
example: LOCAL
enum:
- LOCAL
isActive:
description: 'true: Provider is active
false: Provider is not active'
type: boolean
example: true
registrationDate:
description: Date provider was registered
type: string
format: date-time
example: '2020-04-15T10:08:04.246Z'
lastLoginDate:
description: Most recent time user logged in
type: string
format: date-time
example: '2020-04-15T10:08:04.246Z'
APIError:
description: API error response
type: object
properties:
error:
description: Error condition
type: string
example: USER_NOT_FOUND
code:
description: Error code
type: string
example: '404'
message:
description: Error message
type: string
example: User not found
BaseAddress:
description: User's address
type: object
properties:
attention:
description: Address recipient
type: string
example: Account Manager
address1:
description: Primary address
type: string
example: 1234 Main St.
address2:
description: Second address line
type: string
example: Suite 710
address3:
description: Third address line
type: string
example: Floor 7
city:
description: Address city
type: string
example: Houston
state:
description: Address state
type: string
example: TX
country:
description: Address country
type: string
example: USA
zipCode:
description: Address zip code
type: string
example: 77035
company:
description: Company name
type: string
example: Acme Inc.
kind:
description: Address type
type: string
example: Business
phone:
description: Telephone number and type associated with address
type: object
properties:
number:
description: Telephone number
type: string
example: 555-123-4567
kind:
description: Phone type
type: string
example: Mobile
name:
type: object
properties:
first:
description: First name on address
type: string
example: Pat
last:
description: Last name on address
type: string
example: Kake
email:
description: Email address
type: string
example: test@mail.com
responses:
user-not-found:
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
example:
error: USER_NOT_FOUND
code: '404'
message: User not found
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
example:
error: INTERNAL_SERVER_ERROR
code: '500'
message: Internal server error
securitySchemes:
BearerAuth:
type: http
scheme: bearer
````