Users

Gets a users within the organization.

get

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

200

OK

application/json

created_bystringOptional

created_onintegerOptional

emailstringOptional

first_namestringOptional

idstringOptional

invitedbooleanOptional

is_activebooleanOptional

is_deletedbooleanOptional

last_namestringOptional

mfa_enabledbooleanOptional

org_idstringOptional

rolesstring[]Optional

updated_bystringOptional

updated_onintegerOptional

204

No Content

get

/organization/v1/users

HTTPcURLJavaScriptPython

GET /organization/v1/users HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "created_by": "text",
    "created_on": 1,
    "email": "text",
    "first_name": "text",
    "id": "text",
    "invited": true,
    "is_active": true,
    "is_deleted": true,
    "last_name": "text",
    "mfa_enabled": true,
    "org": {
      "created_by": "text",
      "created_on": 1,
      "current_owner": "text",
      "id": "text",
      "is_active": true,
      "is_deleted": true,
      "name": "text",
      "tier": "text",
      "updated_by": "text",
      "updated_on": 1
    },
    "org_id": "text",
    "roles": [
      "text"
    ],
    "updated_by": "text",
    "updated_on": 1
  }
]

Enable user MFA

post

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

204

No Content

404

Not Found

application/json

post

/organization/v1/users/mfa

HTTPcURLJavaScriptPython

POST /organization/v1/users/mfa HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Deletes user MFA Registration

delete

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

204

No Content

404

Not Found

application/json

delete

/organization/v1/users/mfa

HTTPcURLJavaScriptPython

DELETE /organization/v1/users/mfa HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Gets a user by user id within the organization.

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

Responses

200

OK

application/json

created_bystringOptional

created_onintegerOptional

emailstringOptional

first_namestringOptional

idstringOptional

invitedbooleanOptional

is_activebooleanOptional

is_deletedbooleanOptional

last_namestringOptional

mfa_enabledbooleanOptional

org_idstringOptional

rolesstring[]Optional

updated_bystringOptional

updated_onintegerOptional

get

/organization/v1/users/{user_id}

HTTPcURLJavaScriptPython

GET /organization/v1/users/{user_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

{
  "created_by": "text",
  "created_on": 1,
  "email": "text",
  "first_name": "text",
  "id": "text",
  "invited": true,
  "is_active": true,
  "is_deleted": true,
  "last_name": "text",
  "mfa_enabled": true,
  "org": {
    "created_by": "text",
    "created_on": 1,
    "current_owner": "text",
    "id": "text",
    "is_active": true,
    "is_deleted": true,
    "name": "text",
    "tier": "text",
    "updated_by": "text",
    "updated_on": 1
  },
  "org_id": "text",
  "roles": [
    "text"
  ],
  "updated_by": "text",
  "updated_on": 1
}

Update a user by user id within the organization.

patch

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

Body

application/json

activatebooleanOptional

first_namestringOptional

last_namestringOptional

Responses

200

OK

No content

204

No Content

401

Unauthorized

application/json

404

Not Found

application/json

patch

/organization/v1/users/{user_id}

HTTPcURLJavaScriptPython

PATCH /organization/v1/users/{user_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "activate": true,
  "first_name": "text",
  "last_name": "text"
}

No content

Gets all api keys for a user

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

Responses

200

OK

application/json

api_keystringOptional

created_bystringOptional

created_dateintegerOptional

is_activebooleanOptional

key_idstringOptional

labelstringOptional

updated_bystringOptional

updated_dateintegerOptional

get

/organization/v1/users/{user_id}/api-keys

HTTPcURLJavaScriptPython

GET /organization/v1/users/{user_id}/api-keys HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "api_key": "text",
    "created_by": "text",
    "created_date": 1,
    "is_active": true,
    "key_id": "text",
    "label": "text",
    "updated_by": "text",
    "updated_date": 1
  }
]

Creates a new api key

post

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

Body

application/json

labelstringOptional

Responses

201

Created

post

/organization/v1/users/{user_id}/api-keys

HTTPcURLJavaScriptPython

POST /organization/v1/users/{user_id}/api-keys HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "label": "text"
}

201

Created

No content

Gets key for a user by key id

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

key_idstringRequired

Key identifier

Responses

200

OK

application/json

api_keystringOptional

created_bystringOptional

created_dateintegerOptional

is_activebooleanOptional

key_idstringOptional

labelstringOptional

updated_bystringOptional

updated_dateintegerOptional

get

/organization/v1/users/{user_id}/api-keys/{key_id}

HTTPcURLJavaScriptPython

GET /organization/v1/users/{user_id}/api-keys/{key_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

{
  "api_key": "text",
  "created_by": "text",
  "created_date": 1,
  "is_active": true,
  "key_id": "text",
  "label": "text",
  "updated_by": "text",
  "updated_date": 1
}

Delete key for a user by key id

delete

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

key_idstringRequired

Key identifier

Responses

204

No Content

delete

/organization/v1/users/{user_id}/api-keys/{key_id}

HTTPcURLJavaScriptPython

DELETE /organization/v1/users/{user_id}/api-keys/{key_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

204

No Content

No content

Update key for a user by key id

patch

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

key_idstringRequired

Key identifier

Responses

204

No Content

patch

/organization/v1/users/{user_id}/api-keys/{key_id}

HTTPcURLJavaScriptPython

PATCH /organization/v1/users/{user_id}/api-keys/{key_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

204

No Content

No content

Detaches RBAC role(s) to user by its user id within the organization.

delete

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

Body

application/json

rolesstring[]Optional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

delete

/organization/v1/users/{user_id}/roles

HTTPcURLJavaScriptPython

DELETE /organization/v1/users/{user_id}/roles HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "roles": [
    "text"
  ]
}

No content

Attaches RBAC role(s) to user by its user id within the organization.

patch

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

user_idstringRequired

User identifier

Body

application/json

rolesstring[]Optional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

patch

/organization/v1/users/{user_id}/roles

HTTPcURLJavaScriptPython

PATCH /organization/v1/users/{user_id}/roles HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "roles": [
    "text"
  ]
}

No content