This markdown file contains all api document Order-wise how does flow works of security service
baseSecurityUrl:
localhost:8094
The Security Service API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
#BASE URL
https://localhost:8094
Security Service uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe's servers (these are rare).
Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
| Code | Summary |
|---|---|
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 402 - Request Failed | The parameters were valid but the request failed. |
| 403 - Forbidden | The API key doesn't have permissions to perform the request. |
| 404 - Not Found | The requested resource doesn't exist. |
| 409 - Conflict | The request conflicts with another request (perhaps due to using the same idempotent key) |
| 429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 - Server Errors | Something went wrong on Stripe's end. (These are rare.) |
type string
The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
code string
For some errors that could be handled programmatically, a short string indicating the error code reported.
message string
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
param string
If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
| Error Type | Description |
|---|---|
| api_error | API errors cover any other type of problem (e.g., a temporary problem with Stripe's servers), and are extremely uncommon. |
| card_error | Card errors are the most common type of error you should expect to handle. They result when the user enters a card that can't be charged for some reason. |
| idempotency_error | Idempotency errors occur when an Idempotency-Key |
| invalid_request_error | Invalid request errors arise when your request has invalid parameters. |
End Points
POST /security/permissions/create
POST /security/permissions/{id}
GET /security/permissions/listAll
POST /security/permissions/createPermissionInBatch
POST /security/permissions/createPermissionsByFile
POST /security/permissions/update
POST /security/permissions/delete
/security/permissions/create
Api to create new permission objects.
Method: POST
Params:
service Json permission object
Response:
{} Json of Permission objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/permissions/create' \
--header 'Content-Type: application/json' \
--data-raw '{
"version": 1,
"name": "Test Permision",
"permission": "Team",
"description": "Team menu"
}'
/security/permissions/createPermissionInBatch
Api to create permission by array into json objects
Method: POST
Params:
array into Json permission object
Response:
array of {} Json of Permission objects
CURL
curl --location --request POST '{{baseSecurityUrl}}/security/permissions/createPermissionInBatch' \
--header 'Content-Type: application/json' \
--data-raw '{
"xformation-perfmanager-ui-plugin": [
{
"permission": "catalog-topmenu-manangedashboardsbtn",
"description": "Permissions of '\''Manage Dashboards'\'' Button of '\''xformation-perfmanager-ui-plugin\\src\\domain\\Catalog\\TopMenu.tsx'\''"
},
{
"permission": "catalog-topmenu-catlogbtn",
"description": "Permissions of '\''Catalog'\'' Button of '\''xformation-perfmanager-ui-plugin\\src\\domain\\Catalog\\TopMenu.tsx'\''"
}
],
"grafana-ui": [
{
"permission": "overview",
"description": ""
},
{
"permission": "activity-log",
"description": ""
},
]
}'
/security/permissions/createPermissionsByFile
Method: POST
Params:
array into Json permission object
Response:
array of {} Json of Permission objects
CURL
curl --location --request POST ''{{baseSecurityUrl}}/security/permissions/createPermissionsByFile' \
--form 'inputFile=@"/E:/Desktop/permission.txt"' \
--form 'str="hello"'
/security/permissions/listAll
Api to all permission objects.
Method: POST | GET
Response:
{} Json list of Permission objects
CURL
curl --location -g --request GET '{{baseSecurityUrl}}/permissions/listAll'
/security/permissions/{id}
Api to fetch permission objects by id.
Method: POST
Response:
{} Json of Permission objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/permissions/61'
** /security/permissions/delete/{id} **
Api to delete a permission objects by id.
Method: POST
Response:
Success message
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/permissions/delete/{id}'
/security/permissions/update
Api to update a permission by json objects.
Method: POST
Params:
entity Json permission object
Response:
{} Json of Permission objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/permissions/update' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 105,
"createdBy": "postman",
"updatedBy": "postman",
"version": 1,
"name": "Test Permision",
"permission": "Team",
"description": "Team menu"
}'
/security/permissions/delete
Api to delete a permission by json object.
Method: POST
Params:
entity Json permission object
Response:
Success
After the required permission is created we have to create required roles and role Group
END POINTS
POST /security/roles/create
GET /security/roles/listAll
POST /security/role/{id}
POST /security/roles/delete/{id}
GET /security/roles/listAll
POST /security/roles/update
POST /security/roles/delete
/security/roles/create
Api to create new Role objects.
Method: POST
Params:
service Json Role object
Response:
{} Json of Role objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/roles/create' \
--header 'Content-Type: application/json' \
--data-raw '{
"version": 1,
"name": "Test Role",
"permission": "Test",
"description": "Test role"
}'
/security/roles/listAll
Api to all Role objects.
Method: POST | GET
Response:
{} Json list of Role objects
CURL
curl --location -g --request GET '{{baseSecurityUrl}}/roles/listAll'
/security/role/{id}
Api to fetch Role objects by id.
Method: POST
Response:
{} Json of Role objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/roles/104'
/security/roles/delete/{id}
Api to delete a Role objects by id.
Method: POST
Response:
Success message
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/roles/delete/103'
/security/roles/update
Api to update a Role by json objects.
Note :- While updating the role we can also add permissions via array of permissions json for example :
{
....,
permissions: [
{
"version": 1,
"name": "Test Permision",
"permission": "Team",
"description": "Team menu"
},
{
"version": 1,
"name": "Test Permision",
"permission": "Team",
"description": "Team menu"
}
]
}and roles also can set the particular role is a role group by settng grp: true
We can also make relations between roles one to many, Many to One or Many to Many by seting roles perameter in json objects for example :
{
....,
"roles": [
{
"id": 104
},
{
"id":105
},
]
}
Method: POST
Params:
entity Json Role object
Response:
{} Json of Role objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/roles/update' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 104,
"createdBy": "postman",
"updatedBy": "postman",
"name": "Test Role",
"version": 1,
"grp": false,
"description": "Test role",
"permissions": null,
"roles": null
}'
/security/roles/delete
Api to delete a Role by json object.
Method: POST
Params:
entity Json Role object
Response:
Success
END PONTS
POST /security/users/create
GET /security/users/listAll
POST /security/users/{id}
POST /security/users/delete/{id}
POST /security/users/delete
POST /security/users/update
/security/users/create
Api to create new User objects with require permissions and roles.
Method: POST
Params:
service Json User object
Response:
{} Json of User objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/users/create' \
--header 'Content-Type: application/json' \
--data-raw '{
"username": "test",
"password": "password",
"active": true,
"email": "test.test@synectiks.com",
"roles": [
{
"id": 7,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"name": "Admin_Role_Group",
"version": 1,
"grp": true,
"description": "Admin role group",
"permissions": [],
"roles": [
{
"id": 82,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"name": "Team Menu",
"version": 1,
"grp": false,
"description": "Team menu access role",
"permissions": [
{
"id": 1,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"version": 1,
"name": "Team",
"permission": "Team",
"description": "Team menu"
}
],
"roles": []
},
{
"id": 6,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"name": "Admin",
"version": 1,
"grp": false,
"description": "Admin",
"permissions": [
{
"id": 1,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"version": 1,
"name": "Team",
"permission": "Team",
"description": "Team menu"
},
{
"id": 8,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"version": 1,
"name": "Overview",
"permission": "Overview",
"description": "Overview menu"
}
],
"roles": []
}
]
},
{
"id": 83,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"name": "Team Menu Role",
"version": 1,
"grp": true,
"description": "Team Access Role",
"permissions": [],
"roles": [
{
"id": 82,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"name": "Team Menu",
"version": 1,
"grp": false,
"description": "Team menu access role",
"permissions": [
{
"id": 1,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"version": 1,
"name": "Team",
"permission": "Team",
"description": "Team menu"
}
],
"roles": []
}
]
}
],
"organization": "Synectiks",
"owner": null,
"googleMfaKey": null,
"isMfaEnable": "NO",
"mfaQrImageFilePath": null,
"inviteStatus": null,
"inviteLink": null,
"inviteCode": null,
"inviteSentOn": null,
"tempPassword": null,
"mfaQrCode": null,
"pendingInviteList": null,
"teamList": null,
"isAuthenticatedByUserName": false,
"authenticatedByUserName": false
}'
/security/users/listAll
Api to all User objects.
Method: POST | GET
Response:
{} Json list of User objects
CURL
curl --location -g --request GET '{{baseSecurityUrl}}/users/listAll'
Api to fetch User objects by id.
Method: POST
Response:
{} Json of User objects
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/users/101'
/security/users/delete/{id}
Api to delete a User objects by id.
Method: POST
Response:
Success message
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/users/delete/101'
/security/users/delete
Api to delete a User by json object.
Method: POST
Params:
entity Json User object
Response:
Success
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/users/delete' \
--header 'Content-Type: text/plain' \
--data-raw '{
}'
/security/users/update
Api to update a User by json objects.
Method: POST
Params:
entity Json User object
Response:
{} Json of User objects
END POINTS
POST|GET /security/public/login
POST /security/public/signup
POST /security/public/singin
POST /security/public/authenticate
GET /security/public/logout
/security/public/login
Api to get authenticate user with username and password.
Method: POST | GET
Params:
username* String
password* String
rememberMe boolean
redirectTo String url to redirect on success
Response:
Success authentication response
CURL
curl --location -g --request GET '{{baseSecurityUrl}} public/login?username=test&password=password'
/security/public/signup
Api to get authenticate user with LoginRequest object.
Method: POST
Params:
request* LoginRequest object
Response:
Success authentication response
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/public/signup' \
--header 'Content-Type: application/json' \
--data-raw '{
"username":"test",
"password":"password",
"rememberMe":false
}'
After the signup user can login using this signin api /security/public/signin
Api to get authenticate user with User object.
Method: POST
Params:
request* User object
Response:
Success authentication response
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/public/singin' \
--header 'Content-Type: application/json' \
--data-raw '{
"username":"test",
"password":"password"
}'
/security/public/authenticate
Api to get authenticate user with UsernamePasswordToken object.
Method: POST
Params:
token* UsernamePasswordToken object
Response:
Success authentication response
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/public/authenticate' \
--header 'Content-Type: application/json' \
--data-raw '{
"username":"test",
"password":"password"
}'
/security/public/logout
Api to get authenticate user with UsernamePasswordToken object.
Method: POST | GET
Response:
Success
CURL
curl --location -g --request GET '{{baseSecurityUrl}}/public/logout'
CURL
curl --location -g --request POST '{{baseSecurityUrl}}/users/update' \
--header 'Content-Type: text/plain' \
--data-raw '{}'
Please mail us on
info@syenctiks.com