Invites

get invitations by invitee ID

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

invitee_idstringRequired

Invitee identifier

Responses

200

OK

application/json

created_onintegerOptional

expire_onintegerOptional

idstringOptional

org_idstringOptional

updated_onintegerOptional

get

/organization/v1/invitees/{invitee_id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "created_on": 1,
  "expire_on": 1,
  "id": "text",
  "invitees": [
    {
      "email": "text",
      "id": "text",
      "roles": [
        "text"
      ],
      "status": "text",
      "url": "text"
    }
  ],
  "issuer": {
    "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
  },
  "org_id": "text",
  "updated_on": 1
}

cancel invitations by invitee ID

delete

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

invitee_idstringRequired

Invitee identifier

Responses

200

OK

No content

delete

/organization/v1/invitees/{invitee_id}

HTTPcURLJavaScriptPython

DELETE /organization/v1/invitees/{invitee_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

No content

list invitations

get

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

200

OK

application/json

created_onintegerOptional

expire_onintegerOptional

idstringOptional

org_idstringOptional

updated_onintegerOptional

get

/organization/v1/invites

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "created_on": 1,
    "expire_on": 1,
    "id": "text",
    "invitees": [
      {
        "email": "text",
        "id": "text",
        "roles": [
          "text"
        ],
        "status": "text",
        "url": "text"
      }
    ],
    "issuer": {
      "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
    },
    "org_id": "text",
    "updated_on": 1
  }
]

Create user on-boarding invitations

post

Authorizations

BearerAuth

X-API-KeystringRequired

Bodyobject[]

application/json

emailstringOptional

rolesstring[]Optional

Responses

201

Created

application/json

post

/organization/v1/invites

HTTPcURLJavaScriptPython

POST /organization/v1/invites HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  {
    "email": "text",
    "roles": [
      "text"
    ]
  }
]

201

Created

{
  "failed": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "invite": {
    "created_on": 1,
    "expire_on": 1,
    "id": "text",
    "invitees": [
      {
        "email": "text",
        "id": "text",
        "roles": [
          "text"
        ],
        "status": "text",
        "url": "text"
      }
    ],
    "issuer": {
      "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
    },
    "org_id": "text",
    "updated_on": 1
  }
}

Deprecated

Create user on-boarding invitations

put

Authorizations

BearerAuth

X-API-KeystringRequired

Bodyobject[]

application/json

emailstringOptional

rolesstring[]Optional

Responses

201

Created

application/json

put

/organization/v1/invites

HTTPcURLJavaScriptPython

PUT /organization/v1/invites HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  {
    "email": "text",
    "roles": [
      "text"
    ]
  }
]

201

Created

{
  "failed": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "invite": {
    "created_on": 1,
    "expire_on": 1,
    "id": "text",
    "invitees": [
      {
        "email": "text",
        "id": "text",
        "roles": [
          "text"
        ],
        "status": "text",
        "url": "text"
      }
    ],
    "issuer": {
      "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
    },
    "org_id": "text",
    "updated_on": 1
  }
}

validate invitation

post

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

200

OK

application/json

created_onintegerOptional

expire_onintegerOptional

idstringOptional

org_idstringOptional

updated_onintegerOptional

400

Bad Request

application/json

404

Not Found

application/json

post

/organization/v1/invites/check

HTTPcURLJavaScriptPython

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

[
  {
    "created_on": 1,
    "expire_on": 1,
    "id": "text",
    "invitees": [
      {
        "email": "text",
        "id": "text",
        "roles": [
          "text"
        ],
        "status": "text",
        "url": "text"
      }
    ],
    "issuer": {
      "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
    },
    "org_id": "text",
    "updated_on": 1
  }
]

get invitations by invite ID

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

invite_idstringRequired

Invite identifier

Responses

200

OK

application/json

created_onintegerOptional

expire_onintegerOptional

idstringOptional

org_idstringOptional

updated_onintegerOptional

get

/organization/v1/invites/{invite_id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "created_on": 1,
  "expire_on": 1,
  "id": "text",
  "invitees": [
    {
      "email": "text",
      "id": "text",
      "roles": [
        "text"
      ],
      "status": "text",
      "url": "text"
    }
  ],
  "issuer": {
    "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
  },
  "org_id": "text",
  "updated_on": 1
}

get public key

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

key_versionstringRequired

Key version

Responses

200

OK

application/json

algostringOptional

datastringOptional

idstringOptional

versionstringOptional

get

/public/services/ous/public-key/{key_version}

HTTPcURLJavaScriptPython

GET /public/services/ous/public-key/{key_version} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

{
  "algo": "text",
  "data": "text",
  "id": "text",
  "version": "text"
}