The API allows you to list, view, edit and create authentication domains.
Returns list of authentication domains filtered by specified query parameters.
name | type | description |
---|---|---|
direction | query | |
filter | query | |
hypervisor-manager | query | |
nameLike | query | |
orderBy | query | |
page | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of AuthenticationDomainDetails (JSON) | list of authentication domains filtered by specified query parameters |
GET /authentication-domains
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"present" : true,
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"usedForAuthentication" : true
} ]
Create authentication domain.
media type | data type | description |
---|---|---|
application/json | AuthenticationDomainRequest (JSON) | specify details for new authentication domain |
media type | data type | description |
---|---|---|
application/json | AuthenticationDomainDetails (JSON) | details of newly created authentication domain |
POST /authentication-domains
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"domainId" : "...",
"password" : "...",
"user" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"defaultProjectName" : "...",
"usedForAuthentication" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"present" : true,
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"usedForAuthentication" : true
}
Remove authentication domain.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for authentication domain (use by vProtect) |
DELETE /authentication-domains/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single authentication domain.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for authentication domain (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AuthenticationDomainDetails (JSON) | authentication domain details |
GET /authentication-domains/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"present" : true,
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"usedForAuthentication" : true
}
Change authentication domain details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for authentication domain (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AuthenticationDomainUpdate (JSON) | specify authentication domain details to update |
media type | data type | description |
---|---|---|
application/json | AuthenticationDomainDetails (JSON) | updated details of authentication domain |
PUT /authentication-domains/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"usedForAuthentication" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"present" : true,
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"usedForAuthentication" : true
}
Change password for specified authentication domain.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for authentication domain (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) | specify new password |
PUT /authentication-domains/{guid}/password
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
name | type | description |
---|---|---|
authDomainGuid | path | |
hvmGuid | path |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
PUT /authentication-domains/{hvmGuid}/{authDomainGuid}/used-for-auth
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...