Zentry.Users.Api v1.0

Base URLs:

• http://localhost:5208
• https://api.user.zentrypass.com

Authentication

• API Key (API_KEY)
  • Parameter Name: Api-Key Authentication, in: header.

User

GetCurrentUser

GET /User/me

Responses

Status	Meaning	Description	Schema
200	OK	OK	CurrentUser

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateOrUpdateUser

POST /User/create

Body parameter

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "createUserTenant": true
}

Parameters

Name	In	Type	Required	Description
body	body	CreateOrUpdateUserRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	User

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetUsers

POST /User

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "emails": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetUsersRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Schemas

CreateOrUpdateUserRequest

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "createUserTenant": true
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
createUserTenant	boolean	true	none	Whether or not to create a new tenant for the user account

CurrentUser

{
  "id": "string",
  "roles": [
    "string"
  ],
  "tenantId": "string",
  "tenantName": "string",
  "tenantType": "string",
  "employerIds": [
    "string"
  ],
  "workspaceId": "string",
  "email": "string",
  "emailConfirmed": true,
  "firstName": "string",
  "lastName": "string",
  "pictureUrl": "string",
  "isInternal": true
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the user
roles	[string]¦null	false	none	The roles for this user
tenantId	string¦null	false	none	The tenant this user is currently authenticated to
tenantName	string¦null	false	none	The tenant this user is currently authenticated to
tenantType	string¦null	false	none	The type of tenant this user is currently authenticated to
employerIds	[string]¦null	false	none	This is a legacy property and should not be used anymore. Please use "TenantId" instead
workspaceId	string¦null	false	none	This is a legacy property and should not be used anymore. Please use "TenantId" instead
email	string	true	none	The email of the user
emailConfirmed	boolean	true	none	Flag indicating if the current user's email has been confirmed
firstName	string	true	none	The first name of the user
lastName	string	true	none	The last name of the user
pictureUrl	string¦null	false	none	The url to the picture of the user
isInternal	boolean	true	none	Flag inidcating if the user is an internal user

GetUsersRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "emails": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	UserQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

IPagedRequest

{
  "offset": 0,
  "limit": 25
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	read-only	How far to skip into a collection
limit	integer(int32)	true	read-only	How many results to return

User

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "pictureUrl": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
email	string	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
pictureUrl	string¦null	false	none	none

UserIPagedResponse

{
  "data": [
    {
      "id": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "pictureUrl": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[User]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

UserQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "emails": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
emails	[string]¦null	false	none	none