Skip to main content
API docs by Redocly

Divio Cloud API - Identity and Access Management (IAM) (v3)

Download OpenAPI specification:Download

E-mail: info@divio.com URL: https://www.divio.com/ License: BSD License Terms of Service

github-users

ListGithubUserAccessibleOrganisations

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 100

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 0,
  • "previous": "string",
  • "next": "string"
}

ListGithubUserAccessibleRepositories

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 100
Request Body schema: application/json
required
installation_id
required
integer (Installation id)

Responses

Request samples

Content type
application/json
{
  • "installation_id": 0
}

Response samples

Content type
application/json
{
  • "installation_id": 0,
  • "results": [
    ],
  • "count": 0,
  • "previous": "string",
  • "next": "string"
}

AuthorizeGithubUser

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
code
required
string (Code) non-empty
redirect_uri
string (Redirect uri) non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "redirect_uri": "string"
}

IsGithubUserLoggedIn

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "is_logged_in": true
}

me

GetCurrentUser

Get the details of a single user

Authorizations:
Token
query Parameters
avatar_size
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "timezone": "Africa/Abidjan",
  • "home_organisation": "70fb7386-3e51-4842-b0aa-27fcb6afd307",
  • "enable_beta_features": true,
  • "has_custom_avatar": true,
  • "avatar_images": {},
  • "allow_impersonation_until": "2019-08-24T14:15:22Z",
  • "accepted_marketing": true,
  • "accepted_tos": true,
  • "tracking_id": "string",
  • "features": [
    ],
  • "country": "string",
  • "company": "string",
  • "role": "Agency/Partner",
  • "dev_language": "I am not a developer",
  • "completed_organisation_onboarding_at": "string"
}

me_policy_list

Authorizations:
Token

Responses

organisation-invites

GetPendingOrganisationInvites

List organisation invites

Authorizations:
Token
query Parameters
organisation
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetOrganisationInvitesByCode

Authorizations:
Token
path Parameters
code
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "form": "ACTIVATE",
  • "invite": {
    }
}

DestroyOrganisationInvite

Delete the specified organisation invite

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

ActivateOrganisationInvite

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

organisation-memberships

ListOrganisationMemberships

List organisation memberships

Authorizations:
Token
query Parameters
uuid
Array of strings
organisation
string
account
string
email
string
name
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

include_account
boolean
Default: false

Set this parameter to include account_info in the response

include_organisation
boolean
Default: false

Set this parameter to include organisation_info in the response

avatar_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetOrganisationMembership

Get the details of a single organisation membership

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
query Parameters
include_account
boolean
Default: false

Set this parameter to include account_info in the response

include_organisation
boolean
Default: false

Set this parameter to include organisation_info in the response

avatar_size
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "organisation_info": {
    },
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_info": {
    },
  • "is_admin": true,
  • "is_owner": "string",
  • "can_invite": "string"
}

UpdateOrganisationMembership

Replace the specified organisation membership

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
is_admin
boolean (Is admin)

Responses

Request samples

Content type
application/json
{
  • "is_admin": true
}

Response samples

Content type
application/json
{
  • "is_admin": true
}

PartialUpdateOrganisationMembership

Partially update the specified organisation membership

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
is_admin
boolean (Is admin)

Responses

Request samples

Content type
application/json
{
  • "is_admin": true
}

Response samples

Content type
application/json
{
  • "is_admin": true
}

DestroyOrganisationMembership

Delete the specified organisation membership

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

organisations

ListOrganisations

List organisations

Authorizations:
Token
query Parameters
name_search
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

include_owner_email
boolean
Default: false

Set this parameter to include owner_email in the response

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateOrganisation

Create a new organisation object

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
support_level
string or null (Support level) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "support_level": "string"
}

GetOrganisation

Get the details of a single organisation

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
query Parameters
include_owner_email
boolean
Default: false

Set this parameter to include owner_email in the response

avatar_size
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "owner_email": "user@example.com",
  • "support_level": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "avatar_images": {},
  • "billing_currency": "string",
  • "has_valid_payment_method": true,
  • "has_valid_billing_information": true,
  • "can_add_collaborators": true
}

UpdateOrganisation

Replace the specified organisation

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
support_level
string or null (Support level) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "support_level": "string"
}

PartialUpdateOrganisation

Partially update the specified organisation

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
support_level
string or null (Support level) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "support_level": "string"
}

DestroyOrganisation

Delete the specified organisation

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

UploadOrganisationAvatar

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{}

DeleteOrganisationAvatar

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

InviteOrganisationCollaborators

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
header Parameters
X-Captcha
required
string

Response to a CAPTCHA challenge; the expected format is a single word describing the captcha type, followed by the response itself.

Request Body schema: application/json
required
required
Array of objects (InviteCollaborator)
Array
email
required
string <email> (Email) non-empty
level
required
string (Level)
Enum: "ADMIN" "USER"

Responses

Request samples

Content type
application/json
{
  • "invitations": [
    ]
}

TransferOrganisationOwnership

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
to_membership
required
string <uuid> (To membership)

Responses

Request samples

Content type
application/json
{
  • "to_membership": "df46a8f1-50a3-4a6e-a314-ab7e335be3be"
}

ssh-public-keys

ListSshPublicKeys

List ssh public keys

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateSshPublicKey

Create a new ssh public key object

Authorizations:
Token
Request Body schema: application/json
required
user
required
string <uuid> (User)
title
required
string (Title) [ 1 .. 255 ] characters
public_key
required
string (Public key) non-empty

Responses

Request samples

Content type
application/json
{
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "title": "string",
  • "public_key": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "title": "string",
  • "public_key": "string"
}

GetSshPublicKey

Get the details of a single ssh public key

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "title": "string",
  • "fingerprint": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "last_used": "2019-08-24T14:15:22Z"
}

UpdateSshPublicKey

Replace the specified ssh public key

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

PartialUpdateSshPublicKey

Partially update the specified ssh public key

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

DestroySshPublicKey

Delete the specified ssh public key

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

users

ListUsers

List users

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateUser

Create a new user object

Authorizations:
Token
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

GetUser

Get the details of a single user

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
query Parameters
avatar_size
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "timezone": "Africa/Abidjan",
  • "home_organisation": "70fb7386-3e51-4842-b0aa-27fcb6afd307",
  • "enable_beta_features": true,
  • "has_custom_avatar": true,
  • "avatar_images": {},
  • "allow_impersonation_until": "2019-08-24T14:15:22Z",
  • "accepted_marketing": true,
  • "accepted_tos": true,
  • "tracking_id": "string",
  • "features": [
    ],
  • "country": "string",
  • "company": "string",
  • "role": "Agency/Partner",
  • "dev_language": "I am not a developer",
  • "completed_organisation_onboarding_at": "string"
}

UpdateUser

Replace the specified user

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
first_name
required
string (First name) non-empty [<>&%!#?§;*~/\\\|^=\[\]{}\(\)\"\n\x0B\f\r\x85...
last_name
required
string (Last name) non-empty [<>&%!#?§;*~/\\\|^=\[\]{}\(\)\"\n\x0B\f\r\x85...
timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "US/Alaska" "US/Arizona" "US/Central" "US/Eastern" "US/Hawaii" "US/Mountain" "US/Pacific" "UTC"
accepted_marketing
required
boolean (Accepted marketing)
enable_beta_features
required
boolean (Enable beta features)
allow_impersonation_until
string or null <date-time> (Allow impersonation until)
country
required
string (Country) [ 1 .. 50 ] characters
company
required
string (Company) [ 2 .. 255 ] characters
role
required
string (Role)
Enum: "Agency/Partner" "Professional Developer" "Solution Architect" "Hobbyist" "Student" "Technology Manager" "Product Manager" "Financial Manager" "Manager (Other)" "Other"
dev_language
required
string (Dev language)
Enum: "I am not a developer" "Other" "C / C++" "C#" "Dart" "Go" "Java" "JavaScript" "Kotlin" "PHP" "Python" "Ruby" "Rust" "Scala" "Swift" "TypeScript"
completed_organisation_onboarding_at
required
string (Completed organisation onboarding at) non-empty

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "timezone": "Africa/Abidjan",
  • "accepted_marketing": true,
  • "enable_beta_features": true,
  • "allow_impersonation_until": "2019-08-24T14:15:22Z",
  • "country": "string",
  • "company": "string",
  • "role": "Agency/Partner",
  • "dev_language": "I am not a developer",
  • "completed_organisation_onboarding_at": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "first_name": "string",
  • "last_name": "string",
  • "timezone": "Africa/Abidjan",
  • "accepted_marketing": true,
  • "enable_beta_features": true,
  • "allow_impersonation_until": "2019-08-24T14:15:22Z",
  • "country": "string",
  • "company": "string",
  • "role": "Agency/Partner",
  • "dev_language": "I am not a developer",
  • "completed_organisation_onboarding_at": "string"
}

PartialUpdateUser

Partially update the specified user

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
first_name
required
string (First name) non-empty [<>&%!#?§;*~/\\\|^=\[\]{}\(\)\"\n\x0B\f\r\x85...
last_name
required
string (Last name) non-empty [<>&%!#?§;*~/\\\|^=\[\]{}\(\)\"\n\x0B\f\r\x85...
timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "US/Alaska" "US/Arizona" "US/Central" "US/Eastern" "US/Hawaii" "US/Mountain" "US/Pacific" "UTC"
accepted_marketing
required
boolean (Accepted marketing)
enable_beta_features
required
boolean (Enable beta features)
allow_impersonation_until
string or null <date-time> (Allow impersonation until)
country
required
string (Country) [ 1 .. 50 ] characters
company
required
string (Company) [ 2 .. 255 ] characters
role
required
string (Role)
Enum: "Agency/Partner" "Professional Developer" "Solution Architect" "Hobbyist" "Student" "Technology Manager" "Product Manager" "Financial Manager" "Manager (Other)" "Other"
dev_language
required
string (Dev language)
Enum: "I am not a developer" "Other" "C / C++" "C#" "Dart" "Go" "Java" "JavaScript" "Kotlin" "PHP" "Python" "Ruby" "Rust" "Scala" "Swift" "TypeScript"
completed_organisation_onboarding_at
required
string (Completed organisation onboarding at) non-empty

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "timezone": "Africa/Abidjan",
  • "accepted_marketing": true,
  • "enable_beta_features": true,
  • "allow_impersonation_until": "2019-08-24T14:15:22Z",
  • "country": "string",
  • "company": "string",
  • "role": "Agency/Partner",
  • "dev_language": "I am not a developer",
  • "completed_organisation_onboarding_at": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "first_name": "string",
  • "last_name": "string",
  • "timezone": "Africa/Abidjan",
  • "accepted_marketing": true,
  • "enable_beta_features": true,
  • "allow_impersonation_until": "2019-08-24T14:15:22Z",
  • "country": "string",
  • "company": "string",
  • "role": "Agency/Partner",
  • "dev_language": "I am not a developer",
  • "completed_organisation_onboarding_at": "string"
}

DestroyUser

Delete the specified user

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

UploadUserAvatar

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{}

DeleteUserAvatar

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

ListUserCredentials

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "has_password": true,
  • "otps": [
    ],
  • "recovery_codes": {
    }
}

DeleteUserCredential

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
cred_id
required
string

Responses

GetUserPolicy

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

whoami

whoami_list

Authorizations:
Token

Responses