Update a SAML service provider configuration
Suggest changes
PDFs
PATCH /security/authentication/cluster/saml-sp
Updates a SAML service provider configuration.
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned. |
Request Body
| Name | Type | Description |
|---|---|---|
_links |
||
enabled |
boolean |
The SAML service provider is enabled. Valid for PATCH and GET operations only. |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
}
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
12320791 |
SAML can only be disabled using the console or a SAML-authenticated application. |
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
certificate
security_saml_sp
| Name | Type | Description |
|---|---|---|
_links |
||
enabled |
boolean |
The SAML service provider is enabled. Valid for PATCH and GET operations only. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |