Ga naar inhoud

Gebruikers

Accountscope vereist; voeg de header X-Auth-Account toe met je Account-ID. Deze endpoints zijn niet beschikbaar via OAuth. Elk endpoint op deze pagina vereist een admin-rol op het account — ook GET /api/users en GET /api/users/:id, die 401 teruggeven aan een niet-admin-aanroeper. Voor het aanmaken van een gebruiker moet het account daarnaast een reseller zijn.

Gebruikers opvragen

Vraag alle gebruikers op die aan je account zijn gekoppeld.

GET /api/users

Teruggegeven params
  • users: Array
    • id: String
    • fname: String
    • lname: String
    • email: String
    • account_brand_id: Integer
    • locale: String
    • created_at: DateTime
    • updated_at: DateTime

Gebruiker bekijken

Bekijk een gebruiker.

GET /api/users/:id

Teruggegeven params
  • user: Object
    • id: String
    • fname: String
    • lname: String
    • email: String
    • account_brand_id: Integer
    • locale: String
    • created_at: DateTime
    • updated_at: DateTime

Een gebruiker aanmaken

POST /api/users

Dit maakt een gebruiker aan (en een nieuw sub-account) onder het huidige account. Vereist een reseller-account; aanmaken vanuit een CloudPress-adminaccount geeft 422 terug.

Params
  • user: Object
    • fname: String (required)
    • lname: String (required)
    • email: String (required)
    • company_name: String | Dit wordt de accountnaam.
    • locale: String | en of nl. Laat de sleutel liever helemaal weg dan er een lege string in te zetten — "" wordt met 422 geweigerd
    • billing_term: String | monthly of annual
Teruggegeven params
  • user: Object
    • id: String
    • fname: String
    • lname: String
    • email: String
    • created_at: DateTime
    • updated_at: DateTime
    • password: String | Wordt alleen bij het aanmaken teruggegeven.
    • account_id: String
    • api_token: String | Wordt alleen bij het aanmaken teruggegeven.

password en api_token worden alleen in deze create-response teruggegeven — sla ze meteen op. Gebruik de teruggegeven API-credentials om je voortaan als die gebruiker te authenticeren.

Een gebruiker bijwerken / verwijderen

PATCH /api/users/:id en DELETE /api/users/:id zijn niet toegestaan — de acties zelf geven altijd 401 terug. Het verzoek wordt onderweg nog wel gecontroleerd, dus bij een falende controle krijg je eerst een andere status terug.

Fouten
  • 401 | de aanroeper heeft geen admin-rol op het account — en, zodra elke controle slaagt, de actie zelf
  • 404 | geen gebruiker met dat ID op dit account
  • 422 | het account is geen reseller. Body: {"errors":["Must have reseller permissions"]}