Users
Responses
200
OK
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /v1/users HTTP/1.1
Host:
Accept: */*
{
"users": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"activeAccount": "text",
"email": "text",
"nextLoginAccount": "text",
"requestedMFA": true
},
"status": {}
}
]
}The /users route will add a new user to an existing project. If the create flag is set, and the user doesn't already exist, it will create the user and add a new login in addition to the the project binding.
Body
Body of the request to add a user to an account
createbooleanOptional
Create should be true if the user should be created if they do not exist
emailstringOptional
Email address of the user to add
namestringOptional
Name of the user to add
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
422
Tried to update a non-existing user, use the create flag to create a new user
application/json
500
Internal Server Error
application/json
post
POST /v1/users HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"create": true,
"email": "text",
"name": "text"
}{
"updates": [
{
"before": null,
"reason": "string",
"resource": null,
"status": "error"
}
]
}Path parameters
idstringRequired
the id of the user
Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
get
GET /v1/users/{id} HTTP/1.1
Host:
Accept: */*
{
"user": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"activeAccount": "text",
"email": "text",
"nextLoginAccount": "text",
"requestedMFA": true
},
"status": {}
}
}Was this helpful?