Add user
POSThttp://localhost:8090/api/metalakes/:metalake/users
Add user
Request
Path Parameters
metalake stringrequired
The name of the metalake
- application/json
Body
name stringrequired
The name of the user
Responses
- 200
- 409
- 5xx
Returns the added user object
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- UserResponse
Schema
code int32
Possible values: [0
]
Status code of the response
user
object
{
"code": 0,
"user": {
"name": "string",
"roles": [
"string"
],
"audit": {
"creator": "string",
"createTime": "2024-10-11T06:45:50.687Z",
"lastModifier": "string",
"lastModifiedTime": "2024-10-11T06:45:50.687Z"
}
}
}
{
"code": 0,
"user": {
"name": "user1",
"roles": [],
"audit": {
"creator": "gravitino",
"createTime": "2023-12-08T06:41:25.595Z"
}
}
}
Conflict - The target user already exists in the specified metalake
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- UserAlreadyExistsException
Schema
code integerrequired
Possible values: >= 1000
and <= 1100
HTTP response code
type stringrequired
Internal type definition of the error
message stringrequired
A human-readable message
stack string[]
{
"code": 1002,
"type": "string",
"message": "string",
"stack": [
"string"
]
}
{
"code": 1004,
"type": "UserAlreadyExistsException",
"message": "User already exists",
"stack": [
"org.apache.gravitino.exceptions.UserAlreadyExistsException: User already exists: user1"
]
}
A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
code integerrequired
Possible values: >= 1000
and <= 1100
HTTP response code
type stringrequired
Internal type definition of the error
message stringrequired
A human-readable message
stack string[]
{
"code": 1002,
"type": "string",
"message": "string",
"stack": [
"string"
]
}
{
"code": 1002,
"type": "RuntimeException",
"message": "Internal Server Error",
"stack": [
"java.lang.RuntimeException: Internal Server Error"
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
ResponseClear