Admin | Sections Test

Get all admin users of the contract

get

You can retrieve a complete list of admin users of the contract

Authorizations

Path parameters

contractNumberinteger · int64Required

Responses

200

Success

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

GET /reseller/v2/contracts/{contractNumber}/admins HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

[
  {
    "id": "15514",
    "href": "https://api.ionos.com/reseller/v2/contract/15514/admin/5533",
    "firstName": "text",
    "lastName": "text",
    "email": "text"
  }
]

Create new admin user for contract

post

Authorizations

Path parameters

contractNumberinteger · int64Required

Body

firstNamestringRequired

first name of the user

lastNamestringRequired

last name of the user

emailstringRequired

email of the user

passwordstringRequired

password of the user

Responses

201

Success

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

post

POST /reseller/v2/contracts/{contractNumber}/admins HTTP/1.1
Host: 
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "password": "text"
}

{
  "id": "15514",
  "href": "https://api.ionos.com/reseller/v2/contract/15514/admin/5533",
  "firstName": "text",
  "lastName": "text",
  "email": "text"
}

Find admin by ID

get

Authorizations

Path parameters

contractNumberinteger · int64Required

adminIdinteger · int64Required

Responses

200

Success

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

GET /reseller/v2/contracts/{contractNumber}/admins/{adminId} HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

{
  "id": "15514",
  "href": "https://api.ionos.com/reseller/v2/contract/15514/admin/5533",
  "firstName": "text",
  "lastName": "text",
  "email": "text"
}

Delete admin user

delete

This method call will remove admin user from the contract. This is a highly destructive method and must be used with caution.

Authorizations

Path parameters

contractNumberinteger · int64Required

adminIdinteger · int64Required

Responses

204

Success

application/json

Responseobject

default

Any erroneous status code: 400 (parse error), 401 (auth error), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

delete

DELETE /reseller/v2/contracts/{contractNumber}/admins/{adminId} HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

{}

Partially update admin user

patch

You can use this method to partially update admin user properties (firstName and/or lastName and/or email)

Authorizations

Path parameters

contractNumberinteger · int64Required

adminIdinteger · int64Required

Body

firstNamestringRequired

first name of the user

lastNamestringRequired

last name of the user

emailstringRequired

email of the user

Responses

200

Success

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

patch

PATCH /reseller/v2/contracts/{contractNumber}/admins/{adminId} HTTP/1.1
Host: 
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "firstName": "text",
  "lastName": "text",
  "email": "text"
}

{
  "id": "15514",
  "href": "https://api.ionos.com/reseller/v2/contract/15514/admin/5533",
  "firstName": "text",
  "lastName": "text",
  "email": "text"
}