Create Partner User

Create Partner User

Create partner user

Request
URI
POST
https://vcportal.velocloud.net//api/sase-licensing/v1/partnerUsers
COPY
Request Body
createPartnerUserBody of type(s) application/json
Required 
{
    "userType": "string",
    "username": "support@velocoud.net",
    "domain": "string",
    "firstName": "string",
    "lastName": "string",
    "officePhone": "123456789",
    "mobilePhone": "123456789",
    "email": "support@velocoud.net",
    "isActive": 1,
    "disableSecondFactor": 1,
    "partnerLogicalId": "5cdff30e-8aa0-459e-908d-1366d76882fa",
    "password": "password",
    "roleId": 1019
}
string
userType
Required

userType

string As email As email
username
Required

username

string
domain
Required

domain

string
firstName
Required

firstName

string
lastName
Required

lastName

string As ^\+?[0-9]*$
officePhone
Required

officePhone

string As ^\+?[0-9]*$
mobilePhone
Required

mobilePhone

string As email As email
email
Required

email

number As float As float
isActive
Required

isActive

Possible values are : 1, 0,
number As float As float
disableSecondFactor
Required

disableSecondFactor

Possible values are : 1, 0,
string As uuid As uuid
partnerLogicalId
Optional

Logical ID

string
password
Required

NOTE: Backslash isn't supported

integer
roleId
Required

roleId

Possible values are : 1019, 1020,
Responses
201

Created partner user

Returns createPartnerUserResponse of type(s) application/json 
{
    "userType": "string",
    "username": "support@velocoud.net",
    "domain": "string",
    "firstName": "string",
    "lastName": "string",
    "officePhone": "123456789",
    "mobilePhone": "123456789",
    "email": "support@velocoud.net",
    "isActive": 1,
    "disableSecondFactor": 1,
    "id": 100,
    "lastLogin": "2020-07-18T15:48:18.000Z",
    "created": "2020-07-18T15:48:18.000Z",
    "modified": "2020-07-18T15:48:18.000Z",
    "passwordModified": "2020-07-18T15:48:18.000Z",
    "roleId": 100,
    "roleName": "string",
    "isNative": 1,
    "isLocked": 1
}
string
userType
Required

userType

string As email As email
username
Required

username

string
domain
Required

domain

string
firstName
Required

firstName

string
lastName
Required

lastName

string As ^\+?[0-9]*$
officePhone
Required

officePhone

string As ^\+?[0-9]*$
mobilePhone
Required

mobilePhone

string As email As email
email
Required

email

number As float As float
isActive
Required

isActive

Possible values are : 1, 0,
number As float As float
disableSecondFactor
Required

disableSecondFactor

Possible values are : 1, 0,
integer
id
Required

id

string As date-time As date-time
lastLogin
Required

lastLogin

string As date-time As date-time
created
Required

created

string As date-time As date-time
modified
Required

modified

string As date-time As date-time
passwordModified
Required

passwordModified

integer
roleId
Required

roleId

string
roleName
Required

roleName

number As float As float
isNative
Required

isNative

Possible values are : 1, 0,
number As float As float
isLocked
Required

isLocked

Possible values are : 1, 0,

400

invalid input

Returns httpResponseError of type(s) application/json 
{
    "code": "string",
    "errors": [
        {
            "message": "error",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, DUPLICATE_ENTITY, VCO_API_ERROR, VCO_API_DUPLICATE_ENTERPRISE, VCO_API_NOT_FOUND, VCO_INVALID_CREDENTIALS, PONCHO_API_ERROR,
array of object
errors
Required

errors


500

server internal error

Returns httpResponseError of type(s) application/json 
{
    "code": "string",
    "errors": [
        {
            "message": "error",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, DUPLICATE_ENTITY, VCO_API_ERROR, VCO_API_DUPLICATE_ENTERPRISE, VCO_API_NOT_FOUND, VCO_INVALID_CREDENTIALS, PONCHO_API_ERROR,
array of object
errors
Required

errors


On This Page
Partner Users Operations
POST
Create Partner User
GET
Get All Partner Users
POST
Partner User Reset Password
PATCH
Update Partner User