GET /ssopolicy/{uuid}
/ssopolicy/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
OK
{
"_last_modified": "string",
"authentication_policy": {
"authn_rules": [
{
"action": {
"type": "string"
},
"enable": false,
"index": 0,
"match": {
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
}
},
"name": "string"
}
],
"default_auth_profile_ref": "string"
},
"authorization_policy": {
"authz_rules": [
{
"action": {
"status_code": "string",
"type": "string"
},
"enable": false,
"index": 0,
"match": {
"access_token": {
"matches": [
{
"bool_match": false,
"int_match": 0,
"is_mandatory": false,
"name": "string",
"string_match": {
"match_criteria": "string",
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"type": "string",
"validate": false
}
],
"token_name": "string"
},
"attr_matches": [
{
"attribute_name": "string",
"attribute_value_list": {
"match_criteria": "string",
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
}
}
],
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"method": {
"match_criteria": "string",
"methods": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
}
},
"name": "string"
}
]
},
"configpb_attributes": {
"version": 0
},
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"name": "string",
"tenant_ref": "string",
"type": "string",
"url": "string",
"uuid": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
authentication_policy
authorization_policy
configpb_attributes
List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Name of the SSO Policy. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
SSO Policy Type. Enum options - SSO_TYPE_SAML, SSO_TYPE_PINGACCESS, SSO_TYPE_JWT, SSO_TYPE_LDAP, SSO_TYPE_OAUTH. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition(Allowed values- SSO_TYPE_SAML, SSO_TYPE_JWT, SSO_TYPE_LDAP, SSO_TYPE_OAUTH), Enterprise with Cloud Services edition.
url
UUID of the SSO Policy. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/ssopolicy/{uuid}