Esta é uma API de gerenciamento de usuários ssh.
API de listagem de usuários paginados. Ver documentação de paginação.
Exemplo de requisição
GET /api/sshusers HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
pages = sdk.auth.get_sshusers_pages(cursor=0, size=15)
const pages = sdk.auth.getSSHUsersPages();
const response = await pages.next();
console.log(response.payload);
Exemplo de resposta
HTTP/1.1 200 OK
Content-Type: application/json
{
"cursor": {"current": 0, "next": null, "previous": null},
"users": [
{
"id": 1,
"username": "admin",
"level": "n1",
}
],
}
page = pages.next()
page = pages.previous()
# retornar os itens de uma página
for user in page.users:
print(user)
# retornar os itens de todas as páginas
for user in pages:
print(user)
[
{
id: 1,
username: "admin",
level: "n1"
}
];
API de busca de um usuário ssh existente.
id
Exemplo de requisição
GET /api/sshusers/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
response = sdk.auth.get_sshuser(id=1)
const response = await sdk.auth.getSSHUser({ id: 1 });
console.log(response.payload);
Exemplo de resposta
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 1,
"username": "admin",
"level": "n1",
}
if response.success:
return response.item
{
id: 1,
username: "admin",
level: "n1",
}
API de cadastro de usuários ssh.
Exemplo de requisição
POST /api/sshusers HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
{
"username": "admin",
"level": "n1",
"password": "admin123",
}
from itflex_sdk.auth.types import CreateSSHUserRequest
request = CreateSSHUserRequest(
username="admin",
level="n1",
password="admin123",
)
response = sdk.auth.create_sshuser(request)
const sshuser = sdk.auth.types.SSHUser();
user.username = "docs";
user.level = "n1";
user.password = "hard_password";
const response = sdk.auth.createSSHUser(sshuser);
console.log(response.payload);
Exemplo de resposta
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 1,
"username": "admin",
"level": "n1",
}
if response.success:
return response.payload
{
id: 2,
username: "docs",
level: "n1",
}
API de edição de um usuário ssh existente.
id
Exemplo de requisição
PUT /api/sshusers/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
{
"level": "n1",
"password": "admin123",
}
from itflex_sdk.auth.types import UpdateSSHUserRequest
request = UpdateSSHUserRequest(
id=1,
level="admin@email.com",
password="admin123",
)
response = sdk.auth.update_sshuser(request)
const sshuser = {
id: 1,
username: "docs",
level: "n1",
password: "hard_password"
};
const response = await sdk.auth.updateSSHUser(sshuser);
console.log(response.payload);
Exemplo de resposta
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 1,
"username": "admin",
"level": "n1",
}
if response.success:
return response.payload
{
id: 2,
username: "docs",
level: "n1",
}
API de exclusão de um usuário ssh existente.
id
Exemplo de requisição
DELETE /api/sshusers/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>
response = sdk.auth.delete_sshuser(id=1)
const response = await sdk.auth.deleteSSHUser({ id: 2 });
Exemplo de resposta
HTTP/1.1 200 OK
Content-Type: application/json
return response.success:
Parâmetros da url
Parâmetro | Tipo | Descrição |
---|---|---|
id | integer | Identificador do usuário SSH |
Requisição
Parâmetro | Tipo | Valor Dafault | Descrição |
---|---|---|---|
id | integer | Identificador do usuário | |
level | stringrequerido | Nível de permissão do usuário SSH | |
username | stringrequerido único | Nome de usuário | |
password | stringrequerido | Senha |
Resposta
Parâmetro | Tipo | Descrição |
---|---|---|
id | integer | Identificador do usuário |
username | string | Nome de usuário |
level | string | Nível de permissão do usuário SSH |