Account

Overview

/api/account/

Account API endpoints allow actions to manage user accounts in Astera.

Click on the links below to navigate directly to a specific API endpoint.

Register a new user account

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

firstNamestring · min: 1Required

middleNamestring | nullableOptional

lastNamestring | nullableOptional

userAuthenticationProviderstring · enumRequiredPossible values:

emailstring · email · min: 1Required

userNamestring · min: 1Required

passwordstring | nullableOptional

confirmPasswordstring | nullableOptional

Responses

200

Success

No content

post

/api/account/Register

POST /api/account/Register HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 187

{
  "firstName": "text",
  "middleName": "text",
  "lastName": "text",
  "userAuthenticationProvider": "Centerprise",
  "email": "[email protected]",
  "userName": "text",
  "password": "text",
  "confirmPassword": "text"
}

200

Success

No content

Register Active Directory user

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

firstNamestring · min: 1Required

middleNamestring | nullableOptional

lastNamestring | nullableOptional

userAuthenticationProviderstring · enumRequiredPossible values:

emailstring · email · min: 1Required

userNamestring · min: 1Required

passwordstring | nullableOptional

confirmPasswordstring | nullableOptional

Responses

200

Success

No content

post

/api/account/RegisterActiveDirectoryUser

POST /api/account/RegisterActiveDirectoryUser HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 187

{
  "firstName": "text",
  "middleName": "text",
  "lastName": "text",
  "userAuthenticationProvider": "Centerprise",
  "email": "[email protected]",
  "userName": "text",
  "password": "text",
  "confirmPassword": "text"
}

200

Success

No content

This API returns the bearer token that can be used to make calls to Astera Server, also it returns some more information about the user.

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

userstring · min: 1Required

passwordstring | nullableOptional

rememberMebooleanOptional

Responses

200

Success

No content

post

/api/account/Login

POST /api/account/Login HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 51

{
  "user": "text",
  "password": "text",
  "rememberMe": true
}

200

Success

No content

Sample request body

{
    "user":"admin",
    "password":"Admin123",
    "rememberMe":1
}

Description of Request Body Parameters

Name

Type

Description

user

string

Username of the user trying to login (default is "admin")

password

string

Password of the user trying to login (default is "Admin123")

rememberMe

boolean

This parameter takes 1 or 0, indicating True or False.

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

userstring · min: 1Required

passwordstring | nullableOptional

rememberMebooleanOptional

Responses

200

Success

No content

post

/api/account/LoginActiveDirectoryUser

POST /api/account/LoginActiveDirectoryUser HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 51

{
  "user": "text",
  "password": "text",
  "rememberMe": true
}

200

Success

No content

Initiate password reset

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

emailstring · email · min: 1Required

Responses

200

Success

No content

post

/api/account/ForgotPassword

POST /api/account/ForgotPassword HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

200

Success

No content

Verify password reset token

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

emailstring · email · min: 1Required

tokenstring · min: 1Required

Responses

200

Success

No content

post

/api/account/VerifyPasswordResetToken

POST /api/account/VerifyPasswordResetToken HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 41

{
  "email": "[email protected]",
  "token": "text"
}

200

Success

No content

Reset user password

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

emailstring · email · min: 1Required

passwordstring · min: 1Required

confirmPasswordstring | nullableOptional

tokenstring · min: 1Required

Responses

200

Success

No content

post

/api/account/ResetPassword

POST /api/account/ResetPassword HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 84

{
  "email": "[email protected]",
  "password": "text",
  "confirmPassword": "text",
  "token": "text"
}

200

Success

No content

Request token for user's email change

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

emailstring · email · min: 1Required

newEmailstring · email · min: 1Required

Responses

200

Success

No content

post

/api/account/ChangeEmailTokenRequest

POST /api/account/ChangeEmailTokenRequest HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 54

{
  "email": "[email protected]",
  "newEmail": "[email protected]"
}

200

Success

No content

Verify token for user's email change??

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

newEmailstring · email · min: 1Required

emailstring · email · min: 1Required

tokenstring · min: 1Required

Responses

200

Success

No content

post

/api/account/VerifyChangeEmailToken

POST /api/account/VerifyChangeEmailToken HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 69

{
  "newEmail": "[email protected]",
  "email": "[email protected]",
  "token": "text"
}

200

Success

No content

Change user email address

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

emailstring · email · min: 1Required

newEmailstring · email · min: 1Required

tokenstring · min: 1Required

Responses

200

Success

No content

post

/api/account/ChangeEmail

POST /api/account/ChangeEmail HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 69

{
  "email": "[email protected]",
  "newEmail": "[email protected]",
  "token": "text"
}

200

Success

No content

Change user password

post

Authorizations

Body

currentPasswordstring · min: 1Required

passwordstring · min: 1Required

confirmPasswordstring | nullableOptional

Responses

200

Success

No content

401

Unauthorized

403

Forbidden

post

/api/account/ChangePassword

POST /api/account/ChangePassword HTTP/1.1
Host: hostname:port
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 69

{
  "currentPassword": "text",
  "password": "text",
  "confirmPassword": "text"
}

No content

Confirm user email address

get

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Query parameters

emailstringOptional

codestringOptional

Responses

200

Success

No content

get

/api/account/ConfirmEmail

GET /api/account/ConfirmEmail HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

No content

Confirm user email with email and code in request body

post

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Body

emailstring | nullableOptional

codestring | nullableOptional

Responses

200

Success

No content

post

/api/account/ConfirmEmail

POST /api/account/ConfirmEmail HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 30

{
  "email": "text",
  "code": "text"
}

200

Success

No content

Logout user

get

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Responses

200

Success

No content

get

/api/account/Logout

GET /api/account/Logout HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

No content

Check access status??

get

Authorizations

AuthorizationstringRequired

Please enter into field the word 'Bearer' following by space and JWT

Responses

200

Success

No content

get

/api/account/AccessDenied

GET /api/account/AccessDenied HTTP/1.1
Host: hostname:port
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

No content

Was this helpful?

hashtagOverview

hashtagRegister a new user account

hashtagRegister Active Directory user

hashtagLogin or retrieve authorization token

hashtagSample request body

hashtagDescription of Request Body Parameters

hashtagLogin Active Directory user

hashtagInitiate password reset

hashtagVerify password reset token

hashtagReset user password

hashtagRequest token for user's email change

hashtagVerify token for user's email change??

hashtagChange user email address

hashtagChange user password

hashtagConfirm user email address

hashtagConfirm user email with email and code in request body

hashtagLogout user

hashtagCheck access status??

Overview

Register a new user account

Register Active Directory user

Login or retrieve authorization token

Sample request body

Description of Request Body Parameters

Login Active Directory user

Initiate password reset

Verify password reset token

Reset user password

Request token for user's email change

Verify token for user's email change??

Change user email address

Change user password

Confirm user email address

Confirm user email with email and code in request body

Logout user

Check access status??