API docs by Redocly

zero.Api | v1 (1.0.0)

Download OpenAPI specification:

GetWeatherForecasts

/api/weather-forecasts

Responses

Response samples

Content type
No sample

ValidateSession

/api/users/validate-session

Responses

Response samples

Content type
application/json
{
  • "sessionId": null,
  • "apiKeyId": null,
  • "apiKeyName": null,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "email": "string",
  • "displayName": "string",
  • "expiresAtUtc": "2019-08-24T14:15:22Z"
}

SetUserRoles

/api/users/{userId}/roles

path Parameters
userId
required
string <uuid>
Request Body schema:
required
roleIdentifiers
required
Array of strings

Responses

Request samples

Content type
{
  • "roleIdentifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "roles": [
    ]
}

ListUserRoles

/api/users/{userId}/roles

path Parameters
userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "roles": [
    ]
}

RegisterUser

/api/users/register

Request Body schema:
required
email
required
string <= 320 characters
password
required
string [ 8 .. 128 ] characters
displayName
null or string <= 50 characters
generateDisplayName
boolean

Responses

Request samples

Content type
{
  • "email": "string",
  • "password": "stringst",
  • "displayName": null,
  • "generateDisplayName": true
}

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "email": "string",
  • "displayName": "string"
}

LoginUser

/api/users/login

Request Body schema:
required
email
required
string <= 320 characters
password
required
string <= 128 characters

Responses

Request samples

Content type
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "email": "string",
  • "displayName": "string",
  • "expiresAtUtc": "2019-08-24T14:15:22Z"
}

ListApiKeys

/api/users/api-keys

Responses

Response samples

Content type
application/json
{
  • "apiKeys": [
    ]
}

CreateApiKey

/api/users/api-keys

Request Body schema:
required
name
required
string <= 100 characters
validUntilUtc
string <date-time>

Responses

Request samples

Content type
{
  • "name": "string",
  • "validUntilUtc": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "apiKeyId": "37ba0474-c0bb-4910-bfb5-d6cebb614366",
  • "name": "string",
  • "apiKey": "string",
  • "validUntilUtc": "2019-08-24T14:15:22Z",
  • "createdAtUtc": "2019-08-24T14:15:22Z"
}

GenerateDisplayName

/api/users/display-name

Responses

Response samples

Content type
application/json
{
  • "displayName": "string"
}

ResetPassword

/api/users/forgot-password/reset

Request Body schema:
required
email
required
string <= 320 characters
code
required
string [ 6 .. 20 ] characters
newPassword
required
string [ 8 .. 128 ] characters

Responses

Request samples

Content type
{
  • "email": "string",
  • "code": "string",
  • "newPassword": "stringst"
}

Response samples

Content type
application/json
{
  • "passwordUpdatedAtUtc": "2019-08-24T14:15:22Z"
}

RequestPasswordReset

/api/users/forgot-password/request

Request Body schema:
required
email
required
string <= 320 characters

Responses

Request samples

Content type
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "accepted": true
}

DeleteApiKey

/api/users/api-keys/{apiKeyId}

path Parameters
apiKeyId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "apiKeyId": "37ba0474-c0bb-4910-bfb5-d6cebb614366",
  • "deletedAtUtc": "2019-08-24T14:15:22Z"
}

DeleteAccount

/api/users/account

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "deletedAtUtc": "2019-08-24T14:15:22Z"
}

ChangePassword

/api/users/change-password

Request Body schema:
required
oldPassword
required
string <= 128 characters
newPassword
required
string [ 8 .. 128 ] characters

Responses

Request samples

Content type
{
  • "oldPassword": "string",
  • "newPassword": "stringst"
}

Response samples

Content type
application/json
{
  • "passwordUpdatedAtUtc": "2019-08-24T14:15:22Z"
}

ListRoles

/api/roles

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

CreateRole

/api/roles

Request Body schema:
required
identifier
required
string <= 100 characters
title
required
string <= 100 characters
rightIdentifiers
Array of strings

Responses

Request samples

Content type
{
  • "identifier": "string",
  • "title": "string",
  • "rightIdentifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  • "identifier": "string",
  • "title": "string",
  • "rightIdentifiers": [
    ]
}

DeleteRole

/api/roles/{roleId}

path Parameters
roleId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  • "deletedAtUtc": "2019-08-24T14:15:22Z"
}

ListRights

/api/rights

Responses

Response samples

Content type
application/json
{
  • "rights": [
    ]
}

CreateRight

/api/rights

Request Body schema:
required
identifier
required
string <= 100 characters
title
required
string <= 100 characters

Responses

Request samples

Content type
{
  • "identifier": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "rightId": "b100a986-5417-4169-a73b-79019d7607fd",
  • "identifier": "string",
  • "title": "string"
}

DeleteRight

/api/rights/{rightId}

path Parameters
rightId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "rightId": "b100a986-5417-4169-a73b-79019d7607fd",
  • "deletedAtUtc": "2019-08-24T14:15:22Z"
}