Contiv API documentation version v1

https://{serverfqdn}:10000/api/{version}

  • serverfqdn: required (string)
  • version: required (v1)

Auth API

Authentication/Authorization related API

get

get

post

post

Login to Contiv API server

Login to Contiv API server

Body

Media type: application/json

Type: object

Properties
  • username: required (string)

    user name. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)

  • password: required (string)

Example:

{
-  "username": "johndoe",
-  "password": "p@ssw0rd"
-}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • token: required (string)

    opaque token string, callers should set custom security header to this token before calling further APIs (see security information for protected APIs)

HTTP status code 400

HTTP status code 401

get

get

get post

A collection of authorizations

get

returns a list of authorization.

post

Add a new authorization.

Add a new authorization.

Secured by custom_scheme

A custom security scheme for authenticating requests.

Body

Media type: application/json

Type: object

Properties
  • principalName: required (string)
  • local: required (boolean)
  • role: required (string)
  • tenantName: required (string)

Example:

{
-  "principalName": "johndoe",
-  "local": true,
-  "role": "ops",
-  "tenantName": "johnstenant"
-}

HTTP status code 201

HTTP status code 404

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

get delete

Entity representing authorization

get

returns authorization.

delete

deletes authorization.

returns authorization.

Secured by custom_scheme

A custom security scheme for authenticating requests.

URI Parameters

  • authzUUID: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • principalName: required (string)
  • local: required (boolean)
  • role: required (string)
  • tenantName: required (string)

Example:

{
-  "principalName": "johndoe",
-  "local": true,
-  "role": "ops",
-  "tenantName": "johnstenant"
-}

HTTP status code 404

Body

Media type: application/json

Type:

{"message": "authorization not found" }
-

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

deletes authorization.

Secured by custom_scheme

A custom security scheme for authenticating requests.

URI Parameters

  • authzUUID: required (string)

HTTP status code 204

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

get post

A collection of local_users

get

returns a list of local_user.

post

Add a new local_user.

Add a new local_user.

Secured by custom_scheme

A custom security scheme for authenticating requests.

Body

Media type: application/json

Type: object

Properties
  • username: required (string)
  • password: required (string)
  • firstname: (string)

    Example:

    John
  • lastname: (string)

    Example:

    Doe
  • disable: (boolean)

Example:

{
-  "username": "johndoe",
-  "password": "p@ssw0rd"
-}

HTTP status code 201

HTTP status code 404

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

put get delete

Entity representing local_user

put

updates/creates local_user

get

returns local_user.

delete

deletes local_user.

updates/creates local_user

Secured by custom_scheme

A custom security scheme for authenticating requests.

URI Parameters

  • username: required (string)

Body

Media type: application/json

Type: object

Properties
  • firstname: (string)
  • lastname: (string)
  • disable: (boolean)
  • password: (string)

Example:

{
-  "firstname": "Jane",
-  "disable": true
-}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • username: required (string)
  • password: required (string)
  • firstname: (string)

    Example:

    John
  • lastname: (string)

    Example:

    Doe
  • disable: (boolean)

Example:

{
-  "username": "johndoe",
-  "password": "p@ssw0rd"
-}

HTTP status code 404

Body

Media type: application/json

Type:

{"message": "local_user not found" }
-

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

returns local_user.

Secured by custom_scheme

A custom security scheme for authenticating requests.

URI Parameters

  • username: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • username: required (string)
  • password: required (string)
  • firstname: (string)

    Example:

    John
  • lastname: (string)

    Example:

    Doe
  • disable: (boolean)

Example:

{
-  "username": "johndoe",
-  "password": "p@ssw0rd"
-}

HTTP status code 404

Body

Media type: application/json

Type:

{"message": "local_user not found" }
-

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

deletes local_user.

Secured by custom_scheme

A custom security scheme for authenticating requests.

URI Parameters

  • username: required (string)

HTTP status code 204

Secured by custom_scheme

Headers

  • X-Auth-Token: required (string)

    Used to send a custom token. Obtained via /login API.

put get delete

Entity representing ldap_configuration

put

updates/creates ldap_configuration

get

returns ldap_configuration.

delete

deletes ldap_configuration.