Litmus Portal Authentication API (3.14.0)

Download OpenAPI specification:Download

Litmus Portal Authentication APIs are used to authenticate the identity of a user and to perform several user-specific tasks like:

Update Profile

Change Password

Reset Password

Create new users etc.

ProjectRouter

Accept invitation.

Accept invitation to a project.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Create project.

Create a new project.

Responses

Response samples

200
500

Content type

application/json

{"data": {"createdAt": 0,
"createdBy": {"email": "string",
"userID": "string",
"username": "string"
},
"description": "string",
"isRemoved": true,
"members": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
],
"name": "string",
"projectID": "string",
"state": "string",
"tags": ["string"
],
"updatedAt": 0,
"updatedBy": {"email": "string",
"userID": "string",
"username": "string"
}
}
}

Decline invitation.

Decline invitation to a project.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Delete a project.

Responses

Response samples

200
400
500

Content type

application/json

{"message": "string"
}

Get projects owner.

Return owner of projects.

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"createdAt": 0,
"createdBy": {"email": "string",
"userID": "string",
"username": "string"
},
"description": "string",
"isRemoved": true,
"members": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
],
"name": "string",
"projectID": "string",
"state": "string",
"tags": ["string"
],
"updatedAt": 0,
"updatedBy": {"email": "string",
"userID": "string",
"username": "string"
}
}
]
}

Get user with project.

Return a project.

path Parameters

project_id

required

string

Project ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"createdAt": 0,
"createdBy": {"email": "string",
"userID": "string",
"username": "string"
},
"description": "string",
"isRemoved": true,
"members": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
],
"name": "string",
"projectID": "string",
"state": "string",
"tags": ["string"
],
"updatedAt": 0,
"updatedBy": {"email": "string",
"userID": "string",
"username": "string"
}
}
}

Get active project members.

Return list of active project members.

path Parameters

state

required

string

State

Responses

Response samples

200
500

Content type

application/json

{"data": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
]
}

Get active project Owners.

Return list of active project owners.

path Parameters

state

required

string

State

Responses

Response samples

200
500

Content type

application/json

{"data": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
]
}

Get project Role.

Return role of a project.

path Parameters

project_id

required

integer

Project ID

Responses

Response samples

200
400
500

Content type

application/json

{"role": "string"
}

Get stats of a project.

Return stats of a project.

Responses

Response samples

200
500

Content type

application/json

{"data": [{"members": {"owner": [{"deactivatedAt": 0,
"invitation": "Pending",
"joinedAt": 0,
"userID": "string",
"username": "string"
}
],
"total": 0
},
"name": "string",
"projectID": "string"
}
]
}

Get user with project.

Return users who have a project.

path Parameters

username

required

string

Username

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"createdAt": 0,
"createdBy": {"email": "string",
"userID": "string",
"username": "string"
},
"email": "string",
"id": "string",
"isRemoved": true,
"name": "string",
"projects": [{"createdAt": 0,
"createdBy": {"email": "string",
"userID": "string",
"username": "string"
},
"description": "string",
"isRemoved": true,
"members": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
],
"name": "string",
"projectID": "string",
"state": "string",
"tags": ["string"
],
"updatedAt": 0,
"updatedBy": {"email": "string",
"userID": "string",
"username": "string"
}
}
],
"updatedAt": 0,
"updatedBy": {"email": "string",
"userID": "string",
"username": "string"
},
"username": "string"
}
}

Leave project.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

List invitations.

Return list of invitations.

path Parameters

invitation_state

required

string

Invitation State

Responses

Response samples

200
500

Content type

application/json

{"data": [{"invitationRole": "Owner",
"projectID": "string",
"projectName": "string",
"projectOwner": {"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
}
]
}

Get stats of a project.

Return stats of a project.

Responses

Response samples

200
500

Content type

application/json

{"data": {"projects": [{"createdAt": 0,
"createdBy": {"email": "string",
"userID": "string",
"username": "string"
},
"description": "string",
"isRemoved": true,
"members": [{"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
],
"name": "string",
"projectID": "string",
"state": "string",
"tags": ["string"
],
"updatedAt": 0,
"updatedBy": {"email": "string",
"userID": "string",
"username": "string"
}
}
],
"totalNumberOfProjects": 0
}
}

Remove invitation.

Remove invitation of a project.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Send invitation.

Send invitation to a project.

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"deactivatedAt": 0,
"email": "string",
"invitation": "Pending",
"joinedAt": 0,
"name": "string",
"role": "Owner",
"userID": "string",
"username": "string"
}
}

Update member role.

Return updated member role.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Update project name.

Return updated project name.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

CapabilitiesRouter

Get capabilities of Auth Server.

Returns capabilities that can be leveraged by frontend services to toggle certain features.

Responses

Response samples

200
500

Content type

application/json

{"dex": {"enabled": true
}
}

UserRouter

Creates a new api token for the user.

Responses

Response samples

200
400
500

Content type

application/json

{ }

Create new user.

Responses

Response samples

200
400
401
500

Content type

application/json

{"deactivatedAt": 0,
"email": "string",
"name": "string",
"password": "string",
"role": "string",
"userID": "string",
"username": "string"
}

Get user.

Responses

Response samples

200
400

Content type

application/json

{"deactivatedAt": 0,
"email": "string",
"name": "string",
"password": "string",
"role": "string",
"userID": "string",
"username": "string"
}

Invite users.

Responses

Response samples

200
400
500

Content type

application/json

{"deactivatedAt": 0,
"email": "string",
"name": "string",
"password": "string",
"role": "string",
"userID": "string",
"username": "string"
}

User Login.

Responses

Response samples

200
400
401
500

Content type

application/json

{ }

Revokes the token passed in the Authorization head

Revokes the token passed in the Authorization header.

Responses

Response samples

200
401
500

Content type

application/json

{"message": "string"
}

Delete api token for the user.

Responses

Response samples

200
400
500

Content type

application/json

{"message": "string"
}

Reset user password.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Returns all the api tokens for the user.

Responses

Response samples

200
500

Content type

application/json

{"createdAt": 0,
"expiresAt": 0,
"name": "string",
"token": "string",
"userID": "string"
}

Update users details.

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Update user password.

Responses

Response samples

200
400
401

Content type

application/json

{"message": "string",
"projectID": "string"
}

Updates the user state.

Responses

Response samples

200
400
401

Content type

application/json

{"message": "string"
}

Fetch users.

Responses

Response samples

200
401
500

Content type

application/json

{"deactivatedAt": 0,
"email": "string",
"name": "string",
"password": "string",
"role": "string",
"userID": "string",
"username": "string"
}

DexRouter

DexRouter creates all the required routes for OAut

DexRouter creates all the required routes for OAuth purposes. .

Responses

Response samples

200
500

Content type

application/json

{"response": "string"
}

DexRouter creates all the required routes for OAut

DexRouter creates all the required routes for OAuth purposes. .

Responses

Response samples

200
500

Content type

application/json

{"response": "string"
}

MiscRouter

Return list of tags.

Responses

Response samples

200
500

Content type

application/json

{"collections": "string",
"database": "string"
}

Status will request users list and return, if succ

Status will request users list and return, if successful, a http code 200.

Responses

Response samples

200
500

Content type

application/json

{"status": "string"
}