samlMetadata
Allows Super Admins and Admins to set up SAML-based authentication.
Content type: Application/json
Supported method: GET, POST, and PUT
Sample URL: http://yourfqdn/admin/service/samlMetadata
GET
Sample request
http://example.com/admin/service/samlMetadata
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94bWwgdmVyc2lvbj0iMS4.."
}
}
POST
Sample request
{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94bWwgdm.."
}
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94.."
}
}
Error response
Status code: 405 Method Not Allowed
PUT
Sample request
{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94bWwgdm.."
}
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94.."
}
}
Error response
Status code: 405 Method Not Allowed
Request parameter
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
entityId |
String |
Entity ID of the SAML configuration |
Yes |
|
securityProfile |
String |
PKIX or METAIOP |
Yes |
|
sslSecurityProfile |
String |
PKIX or METAIOP |
Yes |
|
signMetadata |
Boolean |
Specifies a value of true or false |
Yes |
|
base64EncodeMetadata |
String |
Base64 encode IDP Metadata XML |
Yes |