NakisaUserDetails¶
Example Json Object
1{
2 "password": "string",
3 "username": "string",
4 "authorities": [
5 {
6 "authority": "string"
7 }
8 ],
9 "accountNonExpired": true,
10 "accountNonLocked": true,
11 "credentialsNonExpired": true,
12 "enabled": true,
13 "id": 0,
14 "accountId": 0,
15 "fullName": "string",
16 "firstName": "string",
17 "lastName": "string",
18 "email": "string",
19 "audience": [
20 "string"
21 ],
22 "realm": "string",
23 "client": "string",
24 "accessTokenExpiry": 0,
25 "accountName": "string",
26 "environmentName": "string",
27 "serviceAccount": true,
28 "tokenIssuer": "string",
29 "profile": "string",
30 "ncpRoles": [
31 "string"
32 ],
33 "coreServiceRoles": [
34 "string"
35 ]
36}
📄 Description: NakisaUserDetails is a data transfer object that encapsulates essential information about users within the Nakisa platform, including their roles, permissions, and personal attributes, facilitating effective user management and access control in enterprise applications.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
password |
string |
false |
none |
Secure string used to authenticate the user within the NakisaUserDetails schema. |
username |
string |
false |
none |
Represents the unique username associated with the user, facilitating secure identification and access within the system. |
authorities |
false |
none |
An array of user authority details that defines the permissions and access levels assigned to each user within the system. |
|
accountNonExpired |
boolean |
false |
none |
Indicates whether the user’s account is active and has not expired, ensuring continued access to system resources. |
accountNonLocked |
boolean |
false |
none |
Indicates whether the user account is currently locked, affecting the user’s access to the system. |
credentialsNonExpired |
boolean |
false |
none |
Indicates whether the user’s credentials have not expired, ensuring continued access to the system’s resources. |
enabled |
boolean |
false |
none |
Whether this feature is enabled |
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
accountId |
integer(int64) |
false |
none |
Unique identifier for the account |
fullName |
string |
false |
none |
Full name of the resource |
firstName |
string |
false |
none |
Name of the first |
lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification within the Nakisa platform. |
|
audience |
[string] |
false |
none |
An array of NakisaUserDetails representing the users within the target audience for the specified business context. |
realm |
string |
false |
none |
Specifies the realm associated with the user, defining the context within which the user operates in the system. |
client |
string |
false |
none |
Represents the identifier for the client associated with the user, facilitating user-specific data retrieval and management within the system. |
accessTokenExpiry |
integer(int64) |
false |
none |
Represents the expiration time, in seconds, of the access token, ensuring secure and timely user authentication within the application. |
accountName |
string |
false |
none |
Name of the account |
environmentName |
string |
false |
none |
Name of the environment |
serviceAccount |
boolean |
false |
none |
Indicates whether the user has a service account, which allows for automated processes and integrations within the system. |
tokenIssuer |
string |
false |
none |
Identifier for the entity responsible for issuing the authentication token, ensuring secure access to user details within the system. |
profile |
string |
false |
none |
Represents the profile information of the user, encapsulating essential details for personalized user experiences within the application. |
ncpRoles |
[string] |
false |
none |
Array of roles assigned to the user, providing insight into their responsibilities and access levels within the organization. |
coreServiceRoles |
[string] |
false |
none |
An array of roles assigned to the user within the core services, defining their access and responsibilities in the system. |