SystemDomainAuthentication

Resource URI

/services/{serviceId}/endpoints/{endpointId}/systemDomainAuthentication

Items in curly braces represent variables.

Description

Resource for managing secure authentication to a customer back-end system, managing the security layer between the Mashery Traffic Manager and said back-end system.

Resource Schema

Property	Characteristics
type	Type	string
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Required
	Fetch Rule	Implicit
	Description	enum literals: httpBasic, clientSslCert
username	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Required/Used when type = httpBasic
certificate	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Required/Used when type = clientSslCert
password	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Required/Used when type = httpBasic

fetch [GET]

Retrieves the identified SystemDomainAuthentication for the Service Definition.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
fields	false	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter	false	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort	false	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit	false	int	Number of objects to return in the result. Defaults to 100.
offset	false	int	0-based index of first object in the list to return. Defaults to 0.
indent	false	boolean	When set to true, responses are indented for better readability.

Returns

Success

SystemDomainAuthentication for the Service If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "username": "pulvinar sed nisl",
        "certificate": "sed accumsan felis",
        "type": "clientSslCert",
        "password": "aenean"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "username": "vel",
        "certificate": "ornare consequat lectus",
        "type": "clientSslCert",
        "password": "varius ut blandit"
    }
]

create [POST]

Assigns SystemDomainAuthentication to a Service Definition.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
systemDomainAuthentication	true	object	SystemDomainAuthentication object

Returns

Success

SystemDomainAuthentication for the Service If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"certificate":"mauris","username":"elit sodales scelerisque mauris","type":"httpBasic","password":"eu"}

Response

[
    {
        "username": "in congue etiam",
        "certificate": "augue aliquam",
        "type": "clientSslCert",
        "password": "amet diam"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"certificate":"dictumst maecenas","username":"id mauris vulputate elementum","type":"clientSslCert","password":"non"}

Response

[
    {
        "username": "felis ut",
        "certificate": "pellentesque at nulla suspendisse",
        "type": "clientSslCert",
        "password": "at velit"
    }
]

update [PUT]

Updates the SystemDomainAuthentication assigned to the identified Service Definition.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
systemDomainAuthentication	true	object	SystemDomainAuthentication object

Returns

Success

SystemDomainAuthentication for the Service If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"certificate":"donec pharetra magna vestibulum","username":"nullam sit","type":"clientSslCert","password":"libero convallis"}

Response

[
    {
        "username": "vestibulum sagittis sapien",
        "certificate": "ipsum aliquam",
        "type": "clientSslCert",
        "password": "interdum mauris"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"certificate":"cubilia curae duis faucibus","username":"eget","type":"clientSslCert","password":"posuere"}

Response

[
    {
        "username": "sapien",
        "certificate": "diam cras",
        "type": "clientSslCert",
        "password": "et eros"
    }
]

delete [DELETE]

Deletes the SystemDomainAuthentication assigned to the identified Service Definition.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/systemDomainAuthentication' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]