Test Auth Source

Test a new or an existing authentication source in the system

Request

URI

POST

https://{api_host}/suite-api/api/auth/sources/test

COPY

Request Body

Auth source object containing authSource type and the properties of the auth source

auth-source of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "sourceType": {
        "id": "string",
        "name": "string"
    },
    "property": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "certificates": [
        {}
    ]
}

"{\n  \"name\" : \"TEST\",\n  \"sourceType\" : {\n    \"id\" : \"ACTIVE_DIRECTORY\",\n    \"name\" : \"ACTIVE_DIRECTORY\",\n    \"description\" : \"DESC\"\n  },\n  \"created\" : 1744473855827,\n  \"lastModified\" : 1744473855827,\n  \"property\" : [ {\n    \"name\" : \"display-name\",\n    \"value\" : \"Test_11\"\n  }, {\n    \"name\" : \"host\",\n    \"value\" : \"brlrootdc01.vmware.com\"\n  }, {\n    \"name\" : \"domain\",\n    \"value\" : \"vmware.com\"\n  }, {\n    \"name\" : \"host-auto-select\",\n    \"value\" : \"false\"\n  }, {\n    \"name\" : \"use-ssl\",\n    \"value\" : \"true\"\n  }, {\n    \"name\" : \"user-name\",\n    \"value\" : \"[email protected]\"\n  }, {\n    \"name\" : \"password\",\n    \"value\" : \"password\"\n  }, {\n    \"name\" : \"base-domain\",\n    \"value\" : \"dc=vmware,dc=com\"\n  }, {\n    \"name\" : \"common-name\",\n    \"value\" : \"userPrincipalName\"\n  }, {\n    \"name\" : \"port\",\n    \"value\" : \"636\"\n  }, {\n    \"name\" : \"group-search-criteria\",\n    \"value\" : \"(|(objectClass=group)(objectClass=groupOfNames))\"\n  }, {\n    \"name\" : \"member-attribute\",\n    \"value\" : \"member\"\n  }, {\n    \"name\" : \"user-search-criteria\",\n    \"value\" : \"\"\n  }, {\n    \"name\" : \"member-match-field\",\n    \"value\" : \"\"\n  }, {\n    \"name\" : \"ldap-context-attributes\",\n    \"value\" : \"\"\n  } ],\n  \"certificates\" : [ ]\n}"

string As uuid As uuid

Optional

Immutable Identifier of the Auth Source

string

name

Required

Name of the External System. Set by admin when the source is added or imported into vROps.
name and id of a source is unique with the exception that name can be modified by a system admin.

object

sourceType

Required

This object represents the type of external authentication source supported by VMware Cloud Foundation Operations.

integer As int64 As int64

created

Optional

The Auth Source creation/import time in milliseconds

integer As int64 As int64

lastModified

Optional

The Auth Source last modification time in millisecond

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

array of object

property

Required

Properties of the Authentication Source.
The actual values of the metadata elements relevant for the specific Authentication Source

array of object

certificates

Required

Certificate details of the Authentication Source.
Typically this will be present if and only if the Authentication Source enforces SSL

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

AuthSource object that contains authSource ID, authSource type, properties of the auth source and list of certificate details if ssl is enabled

Returns auth-source of type(s) application/json

"{\n  \"id\" : \"00000000-0000-000a-0000-000000000014\",\n  \"name\" : \"TEST\",\n  \"sourceType\" : {\n    \"id\" : \"ACTIVE_DIRECTORY\",\n    \"name\" : \"ACTIVE_DIRECTORY\",\n    \"description\" : \"DESC\"\n  },\n  \"created\" : 1744473855826,\n  \"lastModified\" : 1744473855826,\n  \"property\" : [ {\n    \"name\" : \"display-name\",\n    \"value\" : \"Test_11\"\n  }, {\n    \"name\" : \"host\",\n    \"value\" : \"brlrootdc01.vmware.com\"\n  }, {\n    \"name\" : \"domain\",\n    \"value\" : \"vmware.com\"\n  }, {\n    \"name\" : \"host-auto-select\",\n    \"value\" : \"false\"\n  }, {\n    \"name\" : \"use-ssl\",\n    \"value\" : \"true\"\n  }, {\n    \"name\" : \"user-name\",\n    \"value\" : \"[email protected]\"\n  }, {\n    \"name\" : \"password\",\n    \"value\" : \"password\"\n  }, {\n    \"name\" : \"base-domain\",\n    \"value\" : \"dc=vmware,dc=com\"\n  }, {\n    \"name\" : \"common-name\",\n    \"value\" : \"userPrincipalName\"\n  }, {\n    \"name\" : \"port\",\n    \"value\" : \"636\"\n  }, {\n    \"name\" : \"group-search-criteria\",\n    \"value\" : \"(|(objectClass=group)(objectClass=groupOfNames))\"\n  }, {\n    \"name\" : \"member-attribute\",\n    \"value\" : \"member\"\n  }, {\n    \"name\" : \"user-search-criteria\",\n    \"value\" : \"\"\n  }, {\n    \"name\" : \"member-match-field\",\n    \"value\" : \"\"\n  }, {\n    \"name\" : \"ldap-context-attributes\",\n    \"value\" : \"\"\n  } ],\n  \"certificates\" : [ {\n    \"thumbprint\" : \"1@34343453dfr#@gsrakgb454\",\n    \"certificateDetails\" : \"CERT_DETAILS\"\n  } ]\n}"

string As uuid As uuid

Optional

Immutable Identifier of the Auth Source

string

name

Required

Name of the External System. Set by admin when the source is added or imported into vROps.
name and id of a source is unique with the exception that name can be modified by a system admin.

object

sourceType

Required

This object represents the type of external authentication source supported by VMware Cloud Foundation Operations.

integer As int64 As int64

created

Optional

The Auth Source creation/import time in milliseconds

integer As int64 As int64

lastModified

Optional

The Auth Source last modification time in millisecond

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

array of object

property

Required

Properties of the Authentication Source.
The actual values of the metadata elements relevant for the specific Authentication Source

array of object

certificates

Required

Certificate details of the Authentication Source.
Typically this will be present if and only if the Authentication Source enforces SSL

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"certificates":["object"],"name:"string","property":["object"],"sourceType:"object"}' https://{api_host}/suite-api/api/auth/sources/test

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Auth Operations