redash (0.0.1)

Download OpenAPI specification:Download

/ping

Responses

/status.json

Responses

Response samples

200

Content type

application/json

{"dashboards_count": 0,
"database_metrics": {"metrics": [["string"
]
]
},
"manager": {"last_refresh_at": "string",
"outdated_queries_count": "string",
"query_ids": "string",
"queues": {"celery": {"data_sources": "string",
"size": 0
}
}
},
"queries_count": 0,
"query_results_count": 0,
"redis_used_memory": 0,
"redis_used_memory_human": "string",
"unused_query_results_count": 0,
"version": "string",
"widgets_count": 0,
"workers": [null
]
}

Alert

/api/alerts

Responses

Response samples

200

Content type

application/json

[{"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"state": "string",
"name": "string",
"rearm": 0,
"updated_at": "2019-08-24T14:15:22Z",
"query": {"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"created_at": "2019-08-24T14:15:22Z",
"latest_query_data_id": 0,
"schedule": null,
"description": "string",
"tags": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"last_modified_by": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"options": { },
"version": 0,
"query_hash": "string",
"is_archiverd": true,
"query": "string",
"api_key": "string",
"is_draft": true,
"id": 0,
"data_source_id": 0,
"name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"last_triggered_at": "2019-08-24T14:15:22Z",
"id": 0,
"options": { }
}
]

/api/alerts

Request Body schema: application/json

required	object
name required	string
query_id required	integer
destination_id	integer
rearm	integer

Responses

Request samples

Payload

Content type

application/json

{"options": { },
"name": "string",
"query_id": 0,
"destination_id": 0,
"rearm": 0
}

Response samples

200
400

Content type

application/json

{"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"state": "string",
"name": "string",
"rearm": 0,
"updated_at": "2019-08-24T14:15:22Z",
"query": {"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"created_at": "2019-08-24T14:15:22Z",
"latest_query_data_id": 0,
"schedule": null,
"description": "string",
"tags": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"lats_modified_by": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "string",
"is_inviration_pending": true,
"groups": [0
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"options": { },
"version": 0,
"query_hash": "string",
"is_archived": true,
"query": "string",
"qpi_key": "string",
"is_draft": true,
"id": 0,
"data_source_id": 0,
"name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"last_triggered_at": "2019-08-24T14:15:22Z",
"id": 0,
"options": { }
}

Dashboard

/api/dashbaords

query Parameters

page_size	integer
page	integer
order	string
q	string

Responses

Response samples

200

Content type

application/json

{"count": 0,
"page": 0,
"page_size": 0,
"results": [{"tags": ["string"
],
"is_archiverd": true,
"updated_at": "2019-08-24T14:15:22Z",
"is_favorite": true,
"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"layout": [null
],
"is_draft": true,
"id": 0,
"user_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"slug": "string",
"version": 0,
"widgets": null,
"dashboard_filters_enabled": true
}
]
}

/api/dashbaords

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"tags": ["string"
],
"is_archived": true,
"updated_at": "2019-08-24T14:15:22Z",
"is_favorite": true,
"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"layout": [null
],
"is_draft": true,
"id": 0,
"user_id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"slug": "string",
"version": 0,
"widgets": null,
"dashboard_filters_enabled": true
}

DataSource

/api/data_sources

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"pause_reason": "string",
"syntex": "string",
"paused": 0,
"view_only": true,
"type": "string",
"id": 0
}
]

/api/data_sources

Request Body schema: application/json

required	object
name required	string
type required	string Enum: "mysql" "pg" "prometheus"

Responses

Request samples

Payload

Content type

application/json

{"options": {"dbname": "string"
},
"name": "string",
"type": "mysql"
}

Response samples

200
400

Content type

application/json

{"scheduled_queue_name": "string",
"name": "string",
"pause_reason": "string",
"queue_name": "string",
"syntax": "string",
"paused": 0,
"options": {"dbname": "string"
},
"groups": { },
"type": "string",
"id": 0
}

/api/data_sources/types

Responses

Response samples

200

Content type

application/json

[{"configuration_schema": {"required": ["string"
],
"type": "string",
"properties": {"db": {"type": "string",
"title": "string"
},
"apikey": {"type": "string"
},
"endpoint": {"type": "string"
},
"type": {"type": "string"
},
"get_schema": {"default": true,
"type": "string",
"title": "string"
}
}
},
"type": "string",
"name": "string"
}
]

/api/data_sources/{data_source_id}

path Parameters

data_source_id

required

integer

Responses

Response samples

200

Content type

application/json

{"scheduled_queue_name": "string",
"name": "string",
"pause_reason": null,
"queue_name": "string",
"syntax": "string",
"paused": 0,
"options": {"url": "string"
},
"groups": {"property1": true,
"property2": true
},
"type": "string",
"id": 0
}

/api/data_sources/{data_source_id}

path Parameters

data_source_id

required

integer

Request Body schema: application/json

required	object
name required	string
type required	string Enum: "mysql" "pg" "prometheus"

Responses

Request samples

Payload

Content type

application/json

{"options": {"dbname": "string"
},
"name": "string",
"type": "mysql"
}

Response samples

200

Content type

application/json

{"scheduled_queue_name": "string",
"name": "string",
"pause_reason": null,
"queue_name": "string",
"syntax": "string",
"paused": 0,
"options": {"url": "string"
},
"groups": {"property1": true,
"property2": true
},
"type": "string",
"id": 0
}

/api/data_sources/{data_source_id}

path Parameters

data_source_id

required

integer

Responses

/api/data_sources/{data_source_id}/schema

path Parameters

data_source_id

required

integer

Responses

Response samples

200

Content type

application/json

{"schema": [{"name": "string",
"columns": ["string"
]
}
]
}

/api/data_sources/{data_source_id}/pause

path Parameters

data_source_id

required

integer

Request Body schema: application/json

reason

string

Responses

Request samples

Payload

Content type

application/json

{"reason": "string"
}

Response samples

200

Content type

application/json

{"name": "string",
"pause_reason": "string",
"syntax": "string",
"paused": 0,
"type": "string",
"id": 0
}

/api/data_sources/{data_source_id}/pause

path Parameters

data_source_id

required

integer

Responses

Response samples

200

Content type

application/json

{"name": "string",
"pause_reason": "string",
"syntax": "string",
"paused": 0,
"type": "string",
"id": 0
}

/api/data_sources/{data_source_id}/test

path Parameters

data_source_id

required

integer

Responses

Response samples

200

Content type

application/json

{"message": "string",
"ok": true
}

Group

/api/groups

Responses

Response samples

200

Content type

application/json

[{"created_at": "2019-08-24T14:15:22Z",
"permissions": ["string"
],
"type": "string",
"id": 0,
"name": "string"
}
]

Query

/api/queries

query Parameters

page_size	integer
page	integer
order	string
q	string

Responses

Response samples

200
400

Content type

application/json

{"count": 0,
"page": 0,
"page_size": 0,
"results": [{"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"created_at": "2019-08-24T14:15:22Z",
"runtime": null,
"latest_query_data_id": 0,
"is_favorite": true,
"schedule": null,
"description": "string",
"tags": ["string"
],
"retrieved_at": null,
"updated_at": "2019-08-24T14:15:22Z",
"options": { },
"version": 0,
"last_modified_by_id": 0,
"query_hash": "string",
"is_archived": true,
"query": "string",
"api_key": "string",
"is_draft": true,
"id": 0,
"data_source_id": 0,
"name": "string"
}
]
}

/api/queries

Request Body schema: application/json

data_source_id required	number
query required	string
name required	string
description	string
schedule	string
	object

Responses

Request samples

Payload

Content type

application/json

{"data_source_id": 0,
"query": "string",
"name": "string",
"description": "string",
"schedule": "string",
"options": { }
}

Response samples

200

Content type

application/json

{"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"created_at": "2019-08-24T14:15:22Z",
"latest_query_data_id": 0,
"schedule": "string",
"description": "string",
"tags": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"last_modified_by": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"options": { },
"version": 0,
"is_favorite": true,
"query_hash": "string",
"is_archived": true,
"query": "string",
"api_key": "string",
"is_draft": true,
"id": 0,
"data_source_id": 0,
"name": "string"
}

QueryResult

/api/query_results

Request Body schema: application/json

query required	string
query_id	number
max_age	number
data_source_id required	number
	object

Responses

Request samples

Payload

Content type

application/json

{"query": "string",
"query_id": 0,
"max_age": 0,
"data_source_id": 0,
"parameters": { }
}

Response samples

200
400
403

Content type

application/json

{"job": {"status": 0,
"error": "string",
"id": "string",
"query_result_id": 0,
"updated_at": 0
}
}

User

/api/users

query Parameters

page	integer
page_size	integer
q	string
disabled	boolean
pending	boolean

Responses

Response samples

200

Content type

application/json

{"count": 0,
"page": 0,
"page_size": 0,
"results": [{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}
]
}

/api/users

Request Body schema: application/json

name required	string
email required	string <email>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "[email protected]"
}

Response samples

200
400

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}

path Parameters

userId

required

integer

Responses

Response samples

200

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}

path Parameters

userId

required

integer

Request Body schema: application/json

email	string <email>
name	string
password	string
old_password	string
groups	string

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"name": "string",
"password": "string",
"old_password": "string",
"groups": "string"
}

Response samples

200
400
403

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}

path Parameters

userId

required

integer

Responses

Response samples

200

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}/invite

path Parameters

userId

required

integer

Responses

Response samples

200

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}/reset_password

path Parameters

userId

required

integer

Responses

Response samples

200

Content type

application/json

{"reset_link": "http://example.com"
}

/api/users/{userId}/regenerate_api_key

path Parameters

userId

required

integer

Responses

Response samples

200
404

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}/disable

path Parameters

userId

required

integer

Responses

Response samples

200
404

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

/api/users/{userId}/disable

path Parameters

userId

required

integer

Responses

Response samples

200
404

Content type

application/json

{"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
}

Visualization

/api/visualizations

Request Body schema: application/json

query_id	integer
name	string
description	string
	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"query_id": 0,
"name": "string",
"description": "string",
"options": { },
"type": "string"
}

Response samples

200

Content type

application/json

{"description": null,
"created_at": "string",
"updated_at": "string",
"id": 0,
"type": "string",
"options": { },
"name": "string"
}

Widget

/api/widgets

Request Body schema: application/json

dashboard_id	integer
visualizationid	integer
	object
text	string
width	number

Responses

Request samples

Payload

Content type

application/json

{"dashboard_id": 0,
"visualizationid": 0,
"options": { },
"text": "string",
"width": 0
}

Response samples

200

Content type

application/json

{"widget": { }
}

Destination

/api/destinations

Responses

Response samples

200

Content type

application/json

[{"icon": "string",
"type": "string",
"id": 0,
"name": "string"
}
]

/api/destinations

Request Body schema: application/json

required	object
name required	string
type required	string Value: "email"

Responses

Request samples

Payload

Content type

application/json

{"options": { },
"name": "string",
"type": "email"
}

Response samples

200
400
403

Content type

application/json

{"options": { },
"icon": "string",
"type": "string",
"id": 0,
"name": "string"
}

/api/destinations/types

Responses

Response samples

200

Content type

application/json

[{"configuration_schema": {"required": ["string"
],
"type": "string",
"properties": { }
},
"type": "string",
"name": "string",
"icon": "string"
}
]

/api/destinations/{destination_id}

path Parameters

destination_id

required

integer

Responses

Response samples

200

Content type

application/json

{"options": {"url": "string",
"username": "string",
"channel": "string"
},
"icon": "string",
"type": "string",
"id": 0,
"name": "string"
}

/api/destinations/{destination_id}

path Parameters

destination_id

required

integer

Request Body schema: application/json

required	object
name required	string
type required	string Value: "email"

Responses

Request samples

Payload

Content type

application/json

{"options": { },
"name": "string",
"type": "email"
}

Response samples

200

Content type

application/json

{"options": {"addresses": "string",
"url": "string",
"username": "string",
"channel": "string"
},
"icon": "string",
"type": "string",
"id": 0,
"name": "string"
}

/api/destinations/{destination_id}

path Parameters

destination_id

required

integer

Responses

QuerySnippet

/api/query_snippets

Responses

Response samples

200

Content type

application/json

[{"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"snippet": "string",
"trigger": "string",
"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"id": 0
}
]

/api/query_snippets

Request Body schema: application/json

trigger required	object
description required	string
snippet required	string

Responses

Request samples

Payload

Content type

application/json

{"trigger": { },
"description": "string",
"snippet": "string"
}

Response samples

200
400

Content type

application/json

{"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"snippet": "string",
"trigger": "string",
"user": {"auth_type": "string",
"is_disabled": true,
"updated_at": "2019-08-24T14:15:22Z",
"profile_image_url": "http://example.com",
"is_invitation_pending": true,
"groups": [{"id": 0,
"name": "string"
}
],
"id": 0,
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"disabled_at": "2019-08-24T14:15:22Z",
"is_email_verified": true,
"api_key": "string",
"active_at": "2019-08-24T14:15:22Z",
"email": "[email protected]"
},
"id": 0
}

Setting

/api/settings/organization

Responses

Response samples

200
403

Content type

application/json

{"settings": {"date_format": "string",
"auth_jwt_auth_public_certs_url": "string",
"auth_jwt_auth_issuer": "string",
"auth_jwt_login_enabled": true,
"auth_saml_nameid_format": "string",
"auth_jwt_auth_algorithms": [null
],
"auth_google_apps_domains": [null
],
"auth_jwt_auth_cookie_name": "string",
"auth_jwt_auth_audience": "string",
"auth_jwt_auth_header_name": "string",
"feature_show_permissions_control": true,
"auth_saml_entity_id": "string",
"auth_passowrd_login_enabled": true,
"auth_saml_metadata_url": "string",
"auth_saml_enabled": true
}
}

/api/settings/organization

Request Body schema: application/json

auth_password_login_enabled	boolean
auth_google_apps_domains	string

Responses

Request samples

Payload

Content type

application/json

{"auth_password_login_enabled": true,
"auth_google_apps_domains": "string"
}

Response samples

200
403

Content type

application/json

{"settings": {"date_format": "string",
"auth_jwt_auth_public_certs_url": "string",
"auth_jwt_auth_issuer": "string",
"auth_jwt_login_enabled": true,
"auth_saml_nameid_format": "string",
"auth_jwt_auth_algorithms": [null
],
"auth_google_apps_domains": [null
],
"auth_jwt_auth_cookie_name": "string",
"auth_jwt_auth_audience": "string",
"auth_jwt_auth_header_name": "string",
"feature_show_permissions_control": true,
"auth_saml_entity_id": "string",
"auth_passowrd_login_enabled": true,
"auth_saml_metadata_url": "string",
"auth_saml_enabled": true
}
}