Virima API Specification - SAMLService Services

The requests documented in this section are directed to SAMLService resources, which represent .

Contents

1 editSAML POST Interface
2 getSAMLConfiguration GET Interface
3 getSAMLConfigurationList GET Interface
4 getSAMLMetadata GET Interface

editSAML POST Interface

Method: POST

Relative URL: saml-service/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	SAMLConfiguration

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITSAML 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "loginUrl":"?",
   "idpInfo":"?",
   "logoutUrl":"?",
   "issuerUrl":"?",
   "idpTargetUrl":"?",
   "acsUrl":"?",
   "certificateS3Name":"?",
   "certificateString":"?",
   "signatureAlgorithm":"?",
   "customerId":?,
   "uniqueIdentifier":"?",
   "archive":?,
   "uniqueId":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getSAMLConfiguration GET Interface

Method: GET

Relative URL: saml-service/get-saml-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
configuration	SAMLConfiguration

Example Request:

Example Response:

{
   "id":2147483647,
   "name":"?",
   "loginUrl":"?",
   "idpInfo":"?",
   "logoutUrl":"?",
   "issuerUrl":"?",
   "idpTargetUrl":"?",
   "acsUrl":"?",
   "certificateS3Name":"?",
   "certificateString":"?",
   "signatureAlgorithm":"?",
   "customerId":?,
   "uniqueIdentifier":"?",
   "archive":?,
   "uniqueId":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

getSAMLConfigurationList GET Interface

Method: GET

Relative URL: saml-service/get-saml-configuration-list

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
configuration	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getSAMLMetadata GET Interface

Method: GET

Relative URL: saml-service/get-saml-metadata/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
metadat	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}