Auth API (1.0.0)

Download OpenAPI specification:Download

Auth API performs operations to enable user to authenticate on platform

admin

admin functions

Admin reset password

Admin initiated password reset request on behalf of a user

Authorizations:

jwt

Request Body schema: application/json

Any of

username

required

string

email

Responses

Request samples

Payload

Content type

application/json

{"username": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Admin set password

Admin initiated set password request on behalf of a user

Authorizations:

jwt

Request Body schema: application/json

Any of

username

required

string

email

Responses

Request samples

Payload

Content type

application/json

{"username": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

global

global endpoints

Login

User initiated login

Request Body schema: application/json

Any of

username required	string email address
password required	string <cognito-password> Standard cognito password
newPassword	string <cognito-password> Standard cognito password

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"newPassword": "string"
}

Response samples

Content type

application/json

{"tokens": {"id": "string",
"access": "string",
"refresh": "string",
"expiresIn": 0
},
"challenge": {"session": "string",
"challengeParameters": {"missingAttributes": ["string"
],
"authPlatformId": "string"
},
"challengeName": "string"
}
}

Change Password

User initiated change password request

Request Body schema: application/json

Any of

oldPassword required	string <cognito-password> Standard cognito password
newPassword required	string <cognito-password> Standard cognito password
confirmNewPassword required	string <cognito-password> Standard cognito password

Responses

Request samples

Payload

Content type

application/json

{"oldPassword": "string",
"newPassword": "string",
"confirmNewPassword": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Forgotten Password

User initiated forgotten password request

Request Body schema: application/json

Any of

username

required

string

email

Responses

Request samples

Payload

Content type

application/json

{"username": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Reset password

User initiated forgotten password confirmation request

Request Body schema: application/json

Any of

username required	string
password	string <cognito-password> Standard cognito password
passwordConfirm	string <cognito-password> Standard cognito password
confirmationCode	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"passwordConfirm": "string",
"confirmationCode": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Logout user

Invalidates the users tokens

Authorizations:

jwt

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Refresh tokens

Refresh the Access and ID tokens

Responses

Response samples

Content type

application/json

{"tokens": {"id": "string",
"access": "string",
"refresh": "string",
"expiresIn": 0
},
"challenge": {"session": "string",
"challengeParameters": {"missingAttributes": ["string"
],
"authPlatformId": "string"
},
"challengeName": "string"
}
}

Resend the users password

Resend users temporary password (resend invite)

path Parameters

id

required

string

User AuthPlatform Id

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

user

user endpoints

Confirm Signup

User initiated signup confirmation, takes a username and a confirmation code and sets the users account to confirmed, allowing that user to login

Request Body schema: application/json

username required	string users authPlatformId
confirmationCode required	string Six digit code sent to user to confirm their account

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"confirmationCode": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Send Magic Login Link

Takes a user id and begins authentication through cognito, sending a login link to the user via whatsapp

Request Body schema: application/json

id required	string User Id
redirect required	string Redirect Url

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"redirect": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Verify Magic Link

User was sent whatsapp link with code. Code from that link will be posted to this endpoint to verify their login.

Request Body schema: application/json

id

required

string

Auth Lookup Id

Responses

Request samples

Payload

Content type

application/json

{"id": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Auth service

Ping api

Ping auth api

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Execute event

Execute event in auth module

Authorizations:

jwt

path Parameters

action

required

string

Action to perform

Responses

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}

Update system settings

Change the system settings document in the auth module

Authorizations:

jwt

Request Body schema: application/json

required

object

level required	string
filter required	string or null

Responses

Request samples

Payload

Content type

application/json

{"logging": {"level": "string",
"filter": "string"
}
}

Response samples

Content type

application/json

{"message": "string",
"status": "string"
}