Secret



Represents a write only secret value. Note: The value cannot be retrieved from the API once committed.

Secret [Schema]

Name Type Required Description
Created xsd:dateTime no The creation date of the secret value. Note: This value is auto populated when inserting or updating secrets.
Name xsd:string ( min: 2 max: 100)
Pattern: [A-Za-z0-9\-_]*
yes The secret identifier name. Used to describe the purpose of the secret value.
Value xsd:string ( min: 0 max: 250) yes The secret value. This value will be masked when retrieved from the API.

Employer Secret Example

<?xml version="1.0"?>
<EmployerSecret xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>string</Name>
  <Value>string</Value>
  <Created>2019-11-11T00:00:00+00:00</Created>
</EmployerSecret>
{
  "EmployerSecret": {
    "Name": "string",
    "Value": "string",
    "Created": "2019-11-11T00:00:00+00:00"
  }
}

Employee Secret Example

<?xml version="1.0"?>
<EmployeeSecret xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>string</Name>
  <Value>string</Value>
  <Created>2019-11-11T00:00:00+00:00</Created>
</EmployeeSecret>
{
  "EmployeeSecret": {
    "Name": "string",
    "Value": "string",
    "Created": "2019-11-11T00:00:00+00:00"
  }
}