Zentry.Identity.Api v1.0

Base URLs:

• http://localhost:5083
• https://api.identity.zentrypass.com

Authentication

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

Authorization

Token

POST /connect/token

Body parameter

grant_type: string
username: string
password: string
refresh_token: string

Parameters

Name	In	Type	Required	Description
tenant-id	header	string	false	none
body	body	object	false	none
» grant_type	body	string	false	none
» username	body	string	false	none
» password	body	string	false	none
» refresh_token	body	string	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	LoginResponse

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

Tenant

GetTenants

POST /Tenant

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	GetTenantsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	TenantIPagedResponse

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

AddTenant

POST /Tenant/create

Body parameter

{
  "tenantId": "string",
  "tenantName": "string",
  "tenantType": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AddTenantRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

TwoFactorCode

SendTwoFactorCode

POST /TwoFactorCode/send

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

VerifyTwoFactorCode

POST /TwoFactorCode/verify

Body parameter

{
  "code": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	VerifyTwoFactorCodeRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

User

CreateUser

POST /User

Body parameter

{
  "email": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateUserRequest	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

GET /User

Parameters

Name	In	Type	Required	Description
Offset	query	integer(int32)	false	How far to skip into a collection
Limit	query	integer(int32)	false	How many results to return

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

SignUp

POST /User/signup

Body parameter

{
  "email": "string",
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SignupUserRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	User
400	Bad Request	Bad Request	ProblemDetails

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

AddUserClaim

POST /User/claim

Body parameter

{
  "email": "string",
  "type": "string",
  "value": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AddUserClaimRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

AddUserRole

POST /User/role

Body parameter

{
  "email": "string",
  "role": "string",
  "tenantId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AddUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

RemoveUserRole

DELETE /User/role

Body parameter

{
  "email": "string",
  "role": "string",
  "tenantId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RemoveUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

GetUsersWithRole

POST /User/with-role

Body parameter

{
  "offset": 0,
  "limit": 25,
  "role": "string",
  "tenantId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	GetUsersWithRoleRequest	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

GetApiKey

GET /User/api-key

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetApiKeyResponse

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

GetUserTenants

GET /User/tenants

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetUserTenantsResponse

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

SuspendUser

PUT /User/suspend

Body parameter

{
  "email": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SuspendUserRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

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

Zentry.Identity.Api

post__forgotPassword

POST /forgotPassword

Body parameter

{
  "email": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ForgotPasswordRequest	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	HttpValidationProblemDetails

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

post__resetPassword

POST /resetPassword

Body parameter

{
  "email": "string",
  "resetCode": "string",
  "newPassword": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ResetPasswordRequest	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	HttpValidationProblemDetails

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

Schemas

AddTenantRequest

{
  "tenantId": "string",
  "tenantName": "string",
  "tenantType": "string"
}

Name	Type	Required	Restrictions	Description
tenantId	string	true	none	none
tenantName	string	true	none	none
tenantType	string	true	none	none

AddUserClaimRequest

{
  "email": "string",
  "type": "string",
  "value": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none
type	string	true	none	none
value	string	true	none	none

AddUserRoleRequest

{
  "email": "string",
  "role": "string",
  "tenantId": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none
role	string	true	none	none
tenantId	string	true	none	none

CreateUserRequest

{
  "email": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none

ForgotPasswordRequest

{
  "email": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none

GetApiKeyResponse

{
  "apiKey": "string"
}

Name	Type	Required	Restrictions	Description
apiKey	string	true	none	none

GetTenantsRequest

{
  "offset": 0,
  "limit": 25,
  "tenantIds": [
    "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
tenantIds	[string]¦null	false	none	List of Zentry Pass Tenant Ids

GetUserTenantsResponse

{
  "tenants": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "tenantId": "504d3163bb1ffbbdb02b6c43",
      "tenantName": "Zentry Pass",
      "tenantType": "Individual"
    }
  ]
}

Name	Type	Required	Restrictions	Description
tenants	[Tenant]¦null	false	none	none

GetUsersWithRoleRequest

{
  "offset": 0,
  "limit": 25,
  "role": "string",
  "tenantId": "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
role	string	true	none	none
tenantId	string	true	none	none

HttpValidationProblemDetails

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Name	Type	Required	Restrictions	Description
anonymous	ProblemDetails	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» additionalProperties	any	false	none	none
» errors	object	true	none	none
»» additionalProperties	[string]	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

LoginResponse

{
  "access_token": "string",
  "refresh_token": "string",
  "expires_in": 0
}

Name	Type	Required	Restrictions	Description
access_token	string	true	none	none
refresh_token	string	true	none	none
expires_in	integer(int64)	true	none	none

ProblemDetails

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	none
type	string¦null	false	none	none
title	string¦null	false	none	none
status	integer(int32)¦null	false	none	none
detail	string¦null	false	none	none
instance	string¦null	false	none	none

RemoveUserRoleRequest

{
  "email": "string",
  "role": "string",
  "tenantId": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none
role	string	true	none	none
tenantId	string	true	none	none

ResetPasswordRequest

{
  "email": "string",
  "resetCode": "string",
  "newPassword": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none
resetCode	string	true	none	none
newPassword	string	true	none	none

SignupUserRequest

{
  "email": "string",
  "password": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	none
password	string	true	none	none

SuspendUserRequest

{
  "email": "string"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	The email of the user to suspend

Tenant

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "tenantId": "504d3163bb1ffbbdb02b6c43",
  "tenantName": "Zentry Pass",
  "tenantType": "Individual"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
tenantId	string	true	none	The id of the tenant.
tenantName	string	true	none	The name of the tenant
tenantType	string	true	none	The type of the tenant

TenantIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "tenantId": "504d3163bb1ffbbdb02b6c43",
      "tenantName": "Zentry Pass",
      "tenantType": "Individual"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

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

User

{
  "id": "string",
  "email": "string",
  "emailConfirmed": true,
  "isSuspended": true
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
email	string	true	none	none
emailConfirmed	boolean	true	none	none
isSuspended	boolean	true	none	none

UserIPagedResponse

{
  "data": [
    {
      "id": "string",
      "email": "string",
      "emailConfirmed": true,
      "isSuspended": true
    }
  ],
  "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

VerifyTwoFactorCodeRequest

{
  "code": "string"
}

Name	Type	Required	Restrictions	Description
code	string	true	none	none