Get Auth Source

The auth source can be SSO/LDAP/AD.
For the LDAP/AD auth source, the request should contain the name of the user.
For the SSO auth source, request should contain the name of the user and the sso domain.
User-group's username can contain wildcards. Maximum of 25 user-groups are returned for SSO auth source.

Request

URI

GET

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

COPY

Path Parameters

string

sourceId

Required

Id of the auth source

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

Information about the authentication source

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

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/auth/sources/{sourceId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Auth Operations