Auth Manager Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Rest Endpoints for operations related to auth

authmanager

Operation related to Authentication and Authorization

This API will validate username

This API will validate username based on userid

path Parameters

userid required	string
appid required	string

Responses

API to get list of users for a module with salt

path Parameters

appid

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserDetailsRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userDetails": ["string"
]
}
}

This API will get username

This API will get username based on mobileno

path Parameters

mobilenumber required	string
appid required	string

Responses

This API will fetch all users based on appId and roles

This API will fetch all users based on appId and roles for role bases search only pagination will work,Without role can be searched by all,email,firstName,lastName and userName

path Parameters

appid

required

string

query Parameters

roleName	string
pageStart	integer <int32> Default: 0
pageFetch	integer <int32> Default: 0
email	string
firstName	string
lastName	string
userName	string
search	string

Responses

API to get list of users for a module

path Parameters

appid

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserDetailsRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userDetails": ["string"
]
}
}

This API will get userdetails

This API will get userdetails based on mobileno

path Parameters

mobilenumber required	string
appid required	string

Responses

Gets the user detail based on user id

path Parameters

appid

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserDetailsRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userDetails": ["string"
]
}
}

This API will add password to the user Deprecated

This API will add password to the user

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserPasswordRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"appId": "string",
"userName": "string",
"rid": "string",
"password": "string"
}
}

API to get username

API to get username from userid

path Parameters

appid required	string
userid required	string

Responses

API to get all roles

path Parameters

appid

required

string

Responses

This API will get user role

This API will get user role useing appid and userid

path Parameters

appId required	string
userId required	string

Responses

API to get rid

API to get rid from userid

path Parameters

appid required	string
userid required	string

Responses

This API will reset the password of the particular user

path Parameters

appid

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PasswordDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"oldPassword": "string",
"newPassword": "string",
"userId": "string",
"hashAlgo": "string"
}
}

Logout a user

ends users session

cookie Parameters

Authorization

string

Responses

Login a user Deprecated

internal api for auth code flow

path Parameters

redirectURI

required

string

cookie Parameters

state

required

string

Responses

Login a user Deprecated

internal api for auth code flow

path Parameters

redirectURI

required

string

query Parameters

state required	string
session_state required	string
code required	string

Responses

This API will fetch IndividualId based on appId and userId

path Parameters

appid required	string
userid required	string

Responses

This API will change the password of the particular user

path Parameters

appid

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PasswordDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"oldPassword": "string",
"newPassword": "string",
"userId": "string",
"hashAlgo": "string"
}
}

API to validate token

Responses

API to retry token when access token expires

path Parameters

appid

required

string

Request Body schema: application/json

clientID required	string
clientSecret required	string

Responses

Request samples

Payload

Content type

application/json

{"clientID": "string",
"clientSecret": "string"
}

API to invalidate token when both refresh and auth token expires

Responses

Internal API used by syncdata delegate API to refreah token

Internal API used by syncdata delegate API to refresh token

path Parameters

appid

required

string

Request Body schema: application/json

clientID required	string
clientSecret required	string

Responses

Request samples

Payload

Content type

application/json

{"clientID": "string",
"clientSecret": "string"
}

API to validate token

Responses

Authenticate using username and password Deprecated

Authenticate using username and password

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (LoginUser)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userName": "string",
"password": "string",
"appId": "string"
}
}

API to validate OTP with user Id

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserOtp)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userId": "string",
"otp": "string",
"appId": "string"
}
}

Authenticate using OTP

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (OtpUser)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userId": "string",
"otpChannel": ["string"
],
"appId": "string",
"useridtype": "string",
"templateVariables": {"property1": { },
"property2": { }
},
"context": "string"
}
}

Internal API used by syncdata delegate API to authenticate using otp

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserOtp)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userId": "string",
"otp": "string",
"appId": "string"
}
}

Internal API used by syncdata delegate API to authenticate

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (LoginUserWithClientId)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"userName": "string",
"password": "string",
"appId": "string",
"clientId": "string",
"clientSecret": "string"
}
}

API to authenticate using clientId and secretKey

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ClientSecret)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"clientId": "string",
"secretKey": "string",
"appId": "string"
}
}

Home

Auth Manager Service (1.0)

authmanager

This API will validate username

path Parameters

Responses

API to get list of users for a module with salt

path Parameters

Request Body schema: application/json

Responses

Request samples

This API will get username

path Parameters

Responses

This API will fetch all users based on appId and roles

path Parameters

query Parameters

Responses

API to get list of users for a module

path Parameters

Request Body schema: application/json

Responses

Request samples

This API will get userdetails

path Parameters

Responses

Gets the user detail based on user id

path Parameters

Request Body schema: application/json

Responses

Request samples

This API will add password to the user Deprecated

Request Body schema: application/json

Responses

Request samples

API to get username

path Parameters

Responses

API to get all roles

path Parameters

Responses

This API will get user role

path Parameters

Responses

API to get rid

path Parameters

Responses

This API will reset the password of the particular user

path Parameters

Request Body schema: application/json

Responses

Request samples

Logout a user

cookie Parameters

Responses

Login a user Deprecated

path Parameters

cookie Parameters

Responses

Login a user Deprecated

path Parameters

query Parameters

Responses

This API will fetch IndividualId based on appId and userId

path Parameters

Responses

This API will change the password of the particular user

path Parameters

Request Body schema: application/json

Responses

Request samples

API to validate token

Responses

API to retry token when access token expires

path Parameters

Request Body schema: application/json

Responses

Request samples

API to invalidate token when both refresh and auth token expires

Responses