Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-users-by-pk.StatusCodes.json
2026-07-28 21:39:01 +07:00

202 lines
6.7 KiB
JSON

{
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"description_columns": {
"properties": {
"column_name": {
"description": "The description for the column name. Will be translated by babel",
"example": "A Nice description for the column",
"type": "string"
}
},
"type": "object"
},
"id": { "description": "The item id", "type": "string" },
"label_columns": {
"properties": {
"column_name": {
"description": "The label for the column name. Will be translated by babel",
"example": "A Nice label for the column",
"type": "string"
}
},
"type": "object"
},
"result": {
"properties": {
"active": { "nullable": true, "type": "boolean" },
"changed_by": {
"properties": { "id": { "type": "integer" } },
"type": "object",
"title": "SupersetUserApi.get.User1"
},
"changed_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"created_by": {
"properties": { "id": { "type": "integer" } },
"type": "object",
"title": "SupersetUserApi.get.User"
},
"created_on": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": { "maxLength": 320, "type": "string" },
"fail_login_count": { "nullable": true, "type": "integer" },
"first_name": { "maxLength": 64, "type": "string" },
"groups": {
"properties": {
"description": {
"maxLength": 512,
"nullable": true,
"type": "string"
},
"id": { "type": "integer" },
"label": {
"maxLength": 150,
"nullable": true,
"type": "string"
},
"name": { "maxLength": 100, "type": "string" }
},
"required": ["name"],
"type": "object",
"title": "SupersetUserApi.get.Group"
},
"id": { "type": "integer" },
"last_login": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_name": { "maxLength": 64, "type": "string" },
"login_count": { "nullable": true, "type": "integer" },
"roles": {
"properties": {
"id": { "type": "integer" },
"name": { "maxLength": 64, "type": "string" }
},
"required": ["name"],
"type": "object",
"title": "SupersetUserApi.get.Role"
},
"username": { "maxLength": 128, "type": "string" }
},
"required": ["email", "first_name", "last_name", "username"],
"type": "object",
"title": "SupersetUserApi.get"
},
"show_columns": {
"description": "A list of columns",
"items": { "type": "string" },
"type": "array"
},
"show_title": {
"description": "A title to render. Will be translated by babel",
"example": "Show Item Details",
"type": "string"
}
},
"type": "object"
},
"example": {
"description_columns": {
"column_name": "A Nice description for the column"
},
"id": "string",
"label_columns": { "column_name": "A Nice label for the column" },
"result": {
"active": true,
"changed_on": "2024-01-15T10:30:00Z",
"created_on": "2024-01-15T10:30:00Z",
"email": "string",
"fail_login_count": 1,
"first_name": "string",
"id": 1,
"last_login": "2024-01-15T10:30:00Z",
"last_name": "string",
"login_count": 1,
"username": "string"
},
"show_columns": ["string"],
"show_title": "Show Item Details"
}
}
},
"description": "Item from Model"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": { "message": "Bad request: Invalid parameters provided" }
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": { "message": "Unauthorized: Authentication required" }
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": {
"message": "Not found: The requested resource does not exist"
}
}
},
"description": "Not found"
},
"422": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": { "message": "Unprocessable entity: Validation error" }
}
},
"description": "Could not process entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": {
"message": "Internal server error: An unexpected error occurred"
}
}
},
"description": "Fatal error"
}
}
}