lib/swagger/defs/user.yaml

244 lines
5.3 KiB
YAML
Raw Normal View History

2023-04-06 01:28:58 +00:00
User:
properties:
2023-04-14 17:01:59 +00:00
APIGatewayURL:
description: API Gateway URL
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-14 17:01:59 +00:00
APIGatewayUser:
description: API Gateway User
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
APIKey:
description: API Key
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
AboutMe:
description: About Me
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
AccountID:
description: Account ID
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Address:
2023-04-15 14:27:18 +00:00
$ref: "#/definitions/Address"
x-nullable: true
2023-04-06 01:28:58 +00:00
Alias:
description: Alias
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Auth0UserID:
description: Auth0 User Id
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
CommunityNickname:
description: Nickname
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
CompanyName:
description: Company Name
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
ContactID:
description: Contact
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
CreatedByID:
description: Created User ID
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
CreatedDate:
description: Date Created
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
DelegatedApproverID:
description: Delegated Approver
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Department:
description: Department
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Division:
description: Division
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Email:
description: Email address
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
EmployeeNumber:
description: Employee Number
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
EndOfDay:
description: Time day ends
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Environment:
description: Environment
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Extension:
description: Extension
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Fax:
description: Fax
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
FirstName:
description: The first name
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
ForecastEnabled:
description: Allow Forecasting
type: boolean
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
FullPhotoURL:
description: Full Photo URL
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-14 17:01:59 +00:00
GitHub:
description: GitHub
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
ID:
description: Record ID
type: string
2023-04-06 01:28:58 +00:00
IsActive:
description: Active
type: boolean
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
IsPortalEnabled:
description: Is the user enabled for Communities?
type: boolean
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
IsSystemControlled:
type: boolean
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
LastIP:
description: IP address of last login
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
LastLogin:
description: Last login time
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
LastModifiedByID:
description: Last Modified User ID
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
LastModifiedDate:
description: Last Modified Date
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
LastName:
description: The Last Name
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-14 17:01:59 +00:00
LinkedIn:
description: LinkedIn
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
LoginCount:
description: Number of times user has logged in
format: int64
type: number
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
ManagerID:
description: Manager
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
MobilePhone:
description: Mobile
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Name:
description: Name
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
OutOfOfficeMessage:
description: Out of office message
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Phone:
description: Phone
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
PortalRole:
description: Portal Role Level
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
ProfileID:
description: Profile
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
ReceivesAdminEmails:
description: Info Emails
type: boolean
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
SenderEmail:
description: Email Sender Address
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
SenderName:
description: Email Sender Name
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
SmallPhotoURL:
description: Small Photo URL
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
StartOfDay:
description: The time day starts
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
Status:
2023-04-15 14:27:18 +00:00
description: Onboarding Status
2023-04-11 14:59:35 +00:00
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
TaxnexusAccount:
2023-04-15 14:27:18 +00:00
description: Account
2023-04-06 01:28:58 +00:00
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
TenantID:
description: Tenant ID associated with this user
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
TenantUsers:
items:
2023-04-15 14:27:18 +00:00
$ref: "#/definitions/TenantUser"
2023-04-06 01:28:58 +00:00
type: array
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
TimeZone:
description: Time Zone
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Title:
description: Title
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-14 17:01:59 +00:00
Twitter:
description: Twitter
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
UserRoleID:
description: Role
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
UserRoles:
items:
2023-04-15 14:27:18 +00:00
$ref: "#/definitions/UserRole"
2023-04-06 01:28:58 +00:00
type: array
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
UserType:
description: User Type
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
Username:
description: Username
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-06 01:28:58 +00:00
type: object