Get Authorization
Default Module
YMS SaaS Platform Base API - Core Functionality Only
Base URLs:
<a href="https://yms-staging.item.com/api/yms">staging: https://yms-staging.item.com/api/yms</a>
Authentication
HTTP Authentication, scheme: bearer
Auth Management/Level 1
POST Login by Password
POST /auth/yms/login-by-password
Body Request Parameters
Request Parameters
Name | Location | Type | Required | Description |
|---|---|---|---|---|
X-Tenant-ID | header | string | No | none |
Item-Time-Zone | header | string | No | none |
Authorization | header | string | No | none |
body | body | UserLoginCmd | No | none |
Response Example
200 Response
Response
Status Code | Status Code Description | Description | Data Model |
|---|---|---|---|
200 | OK | none | RUserLoginView |
Data Models
YardIsolatedView
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
yardId | string | false | none | none | |
yardName | string | false | none | none | |
timezone | string | false | none | none |
UserProfileView
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
userId | string | false | none | Unique identifier for the user in the system | |
userName | string | false | none | Display name of the user as shown in the interface | |
admin | boolean | false | none | Administrative privilege status indicating whether the user has system admin rights (true/false) | |
tenantId | string | false | none | Tenant identifier that the user belongs to for multi-tenant isolation | |
yardList | [YardIsolatedView] | false | none | Detailed list of yards the user has access to with complete yard information and isolation settings | |
yardIds | [string] | false | none | Simple list of yard identifiers that the user has access to, used for quick reference | |
defaultYardId | string | false | none | Default yard identifier that is automatically selected for this user when logging in |
UserLoginView
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
refreshToken | string | false | none | JWT refresh token used to obtain new access tokens | |
accessToken | string | false | none | JWT access token for authenticating API requests | |
idToken | string | false | none | JWT ID token containing user identity information | |
userProfile | UserProfileView | false | none | Basic user profile information including name, email, etc. | |
userDetail | UserDetailView | false | none | Detailed user information including preferences and settings | |
tenants | [Tenant] | false | none | List of tenant organizations that the user has access to | |
tenantUserProfilesMap | MapUserProfileView | false | none | Map of user profiles for each tenant, keyed by tenant ID |
RUserLoginView
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
code | integer(int64) | false | none | none | |
msg | string | false | none | none | |
success | boolean | false | none | none | |
data | UserLoginView | false | none | none |
UserLoginCmd
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
username | string | true | none | none | |
password | string | true | none | none | |
tenantId | string | false | none | none |
PermissionDTO
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
id | integer(int64) | false | none | none | |
name | string | false | none | none | |
parentId | integer(int64) | false | none | none | |
title | string | false | none | none |
UserDetailView
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
string | false | none | none | ||
firstName | string | false | none | none | |
lastName | string | false | none | none | |
userName | string | false | none | none | |
userPermissions | [PermissionDTO] | false | none | none |
key
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
userId | string | false | none | Unique identifier for the user in the system | |
userName | string | false | none | Display name of the user as shown in the interface | |
admin | boolean | false | none | Administrative privilege status indicating whether the user has system admin rights (true/false) | |
tenantId | string | false | none | Tenant identifier that the user belongs to for multi-tenant isolation | |
yardList | [YardIsolatedView] | false | none | Detailed list of yards the user has access to with complete yard information and isolation settings | |
yardIds | [string] | false | none | Simple list of yard identifiers that the user has access to, used for quick reference | |
defaultYardId | string | false | none | Default yard identifier that is automatically selected for this user when logging in |
YardInfo
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
yardId | string | false | none | Unique yard identifier | |
yardName | string | false | none | Human-readable yard name for display | |
timezone | string | false | none | Timezone identifier of the yard, e.g., "America/Los_Angeles" |
Tenant
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
tenantId | string | false | none | Unique tenant identifier | |
tenantName | string | false | none | Human-readable tenant name for display | |
unisCompany | boolean | false | none | Whether this tenant is a UniS company | |
yards | [YardInfo] | false | none | List of yards associated with this tenant<br />Defaults to empty list to ensure safe iteration |
MapUserProfileView
Properties
Name | Type | Required | Constraints | Title | Description |
|---|---|---|---|---|---|
key | key | false | none | none |