Get all the schemes for the project
- 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Get all the schemes for the project
- Updated On 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v2/Project/Schemes
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Responses
200
Success
Schemes - 200 Status response.
The below example shows the schemes response for the project.
{
"schemes": [
{
"id": "1",
"sso_name": "SSO1",
"project_id": "1",
"scheme_name": "Scheme1",
"display_name": "Scheme1"
},
{
"id": "2",
"sso_name": "SSO2",
"project_id": "1",
"scheme_name": "Scheme2",
"display_name": "Scheme2"
}
],
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "No schemes found for the project.",
"error_code": "",
"custom_data": null
}
],
"warnings": [],
"information": []
}object
schemes
Array of object (SSOSchemeDetails) | null
object
id
string | null
sso_name
string | null
project_id
string | null
scheme_name
string | null
display_name
string | null
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
400
Bad Request
Schemes - 400 Status response.
The below example shows that the Schemes failed to fetch
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "No schemes found for the project.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}object
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
Was this article helpful?
