Add Auth Source

Add Auth Source

If the authentication source is of type LDAP or AD and if ssl is enabled, the response object will contain a list of certificates found matching with the provided host.If the authentication source is not of type LDAP or AD (or) if ssl is not enabled, then the authentication source is available for use as soon as the api call is successful.It is the duty of the caller to call the PATCH (/sources) api with the certificate details. Once the PATCH api call is successful, the authentication source is available for use.

Request
URI
POST
https://{api_host}/suite-api/api/auth/sources
COPY
Request Body

Contains authSource's type and its properties

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\" : 1744473855783,\n  \"lastModified\" : 1744473855783,\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
id
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.
Responses
200

The Auth source is not created in the system and ssl certificate details are returned as response. The caller has to call the PATCH (/auth/sources) API with the certificate details.

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\" : 1744473855781,\n  \"lastModified\" : 1744473855781,\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
id
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


201

The Auth source is created in the system

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\" : 1744473855782,\n  \"lastModified\" : 1744473855782,\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
id
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
On This Page
Auth Operations
GET
Get Users
PUT
Modify User
POST
Create User
DELETE
Delete Users
PUT
Assign Traversal Spec To User
Deprecated
GET
Get Assigned Role Permissions For User
PUT
Assign Role Permission To User
PUT
Change Password
GET
Get User Groups
PUT
Modify User Group
POST
Create User Group
DELETE
Delete User Groups
PUT
Assign Traversal Spec To User Group
Deprecated
GET
Get Assigned Role Permissions For User Group
PUT
Assign Role Permission To User Group
GET
Get Auth Sources
PUT
Update Auth Source
POST
Add Auth Source
PATCH
Patch Auth Source With Certificate Details
PUT
Synchronize User Groups
GET
Get All Object Scopes
PUT
Modify Scope
POST
Create Scope
DELETE
Delete Scopes
GET
Get Roles
PUT
Update User Role
POST
Create User Role
GET
Get Role Privileges
PUT
Set Role Privileges
POST
Add Role Privileges
DELETE
Remove Role Privileges
POST
Release Token
POST
Acquire Token
POST
Import Users
POST
Search Users For Auth Source
POST
Search User Groups For Auth Source
POST
Test Auth Source
PATCH
Patch Test Auth Source
GET
Get User
DELETE
Delete User
GET
Get User Group
DELETE
Delete User Group
GET
Get Traversal Specs
GET
Get Auth Source Types
GET
Get Auth Source Type
GET
Get Auth Source
DELETE
Delete Auth Source
GET
Get Scope
GET
Get Role By Name
DELETE
Delete User Role
GET
Get Available Privileges
GET
Get Available Privilege Groups
GET
Get Current User
GET
Get Current User Role Privileges
GET
Get Assigned Role Permissions For Current User
DELETE
Unassigned Role Permission From User
DELETE
Unassigned Role Permission From User Group