Test Auth Source Using POST

• Auth

Test a new or an existing authentication source in the system

Request

URI

POST

https://{api_host}/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

{
    "id": "string",
    "name": "string",
    "sourceType": {
        "id": "string",
        "name": "string"
    }
}

{
    "certificates": [
        {
            "certificateDetails": "string",
            "expires": "string",
            "issuedBy": "string",
            "issuedTo": "string",
            "thumbprint": "string"
        }
    ],
    "created": 0,
    "id": "string",
    "lastModified": 0,
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "property": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "sourceType": {
        "description": "string",
        "id": "string",
        "links": [
            {
                "description": "string",
                "href": "string",
                "name": "string",
                "rel": "string"
            }
        ],
        "name": "string",
        "properties": {
            "property": [
                {
                    "dataType": "string",
                    "description": "string",
                    "modifiable": false,
                    "name": "string",
                    "required": false
                }
            ]
        }
    }
}

array of certificate

certificates

Optional

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

integer As int64 As int64

created

Optional

The Auth Source creation/import time in milliseconds

string As uuid As uuid

id

Required

Immutable Identifier of the Auth Source

integer As int64 As int64

lastModified

Optional

The Auth Source last modification time in millisecond

array of link

links

Optional

links

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.

array of name-value

property

Optional

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

auth-sourcetype

sourceType

Required

This object represents the type of external authentication source supported by vRealize Operations Manager.

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

Hide Details

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

{
    "certificates": [
        {
            "certificateDetails": "string",
            "expires": "string",
            "issuedBy": "string",
            "issuedTo": "string",
            "thumbprint": "string"
        }
    ],
    "created": 0,
    "id": "string",
    "lastModified": 0,
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "property": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "sourceType": {
        "description": "string",
        "id": "string",
        "links": [
            {
                "description": "string",
                "href": "string",
                "name": "string",
                "rel": "string"
            }
        ],
        "name": "string",
        "properties": {
            "property": [
                {
                    "dataType": "string",
                    "description": "string",
                    "modifiable": false,
                    "name": "string",
                    "required": false
                }
            ]
        }
    }
}

array of certificate

certificates

Optional

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

integer As int64 As int64

created

Optional

The Auth Source creation/import time in milliseconds

string As uuid As uuid

id

Required

Immutable Identifier of the Auth Source

integer As int64 As int64

lastModified

Optional

The Auth Source last modification time in millisecond

array of link

links

Optional

links

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.

array of name-value

property

Optional

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

auth-sourcetype

sourceType

Required

This object represents the type of external authentication source supported by vRealize Operations Manager.

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Auth Operations

POST

Acquire Token Using POST

POST

Add Auth Source Using POST

POST

Add Role Privileges Using POST

PUT

Assign Role Permission To User Group Using PUT

PUT

Assign Role Permission To User Using PUT

PUT

Assign Traversal Spec To User Group Using PUT

Deprecated

PUT

Assign Traversal Spec To User Using PUT

Deprecated

PUT

Change Password Using PUT

POST

Create User Group Using POST

POST

Create User Role Using POST

POST

Create User Using POST

DELETE

Delete Auth Source Using DELETE

DELETE

Delete User Groups Using DELETE

DELETE

Delete User Group Using DELETE

DELETE

Delete User Role Using DELETE

DELETE

Delete Users Using DELETE

DELETE

Delete User Using DELETE

GET

Get Assigned Role Permissions For Current User Using GET

GET

Get Assigned Role Permissions For User Group Using GET

GET

Get Assigned Role Permissions For User Using GET

GET

Get Auth Sources Using GET

GET

Get Auth Source Types Using GET

GET

Get Auth Source Type Using GET

GET

Get Auth Source Using GET

GET

Get Available Privilege Groups Using GET

GET

Get Available Privileges Using GET

GET

Get Current User Role Privileges Using GET

GET

Get Current User Using GET

GET

Get Role By Name Using GET

GET

Get Role Privileges Using GET

GET

Get Roles Using GET

GET

Get Traversal Specs Using GET

GET

Get User Groups Using GET

GET

Get User Group Using GET

GET

Get Users Using GET

GET

Get User Using GET

POST

Import Users Using POST

PUT

Modify User Group Using PUT

PUT

Modify User Using PUT

PATCH

Patch Auth Source With Certificate Details Using PATCH

PATCH

Patch Test Auth Source Using PATCH

POST

Release Token Using POST

DELETE

Remove Role Privileges Using DELETE

POST

Search User Groups For Auth Source Using POST

POST

Search Users For Auth Source Using POST

PUT

Set Role Privileges Using PUT

PUT

Synchronize User Groups Using PUT

POST

Test Auth Source Using POST

DELETE

Unassigned Role Permission From User Group Using DELETE

DELETE

Unassigned Role Permission From User Using DELETE

PUT

Update Auth Source Using PUT

PUT

Update User Role Using PUT