#%RAML 0.8
title: Authentication API
baseUri: https://apistg.np.covapp.io/authn/v2
protocols:
- HTTPS
schemas:
- resourceReference: |
    {
      "id" : "http://api.covisint.com/schema/resourceReference",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "description" : "Schema representing links",
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "maxLength" : 36,
          "description" : "The unique identifier for the resource.",
          "required": true
        },
        "type" : {
          "type" : "string",
          "description" : "The type of the resource."
        },
        "realm" : {
          "type" : "string",
          "description" : "The realm of the resource."
        }
      }
    }
- namedResourceReference: "{\n  \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Expands on the basic resource reference and adds internationalized
    name and description.\",\n  \"extends\" : {\n        \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n
    \ },\n  \"properties\" : {\n     \"name\" : {  \n       \"description\": \"Internationalized
    resource name.\",\n       \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n
    \    },\n     \"description\" : {  \n       \"description\": \"Internationalized
    resource description.\",\n       \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n
    \    }\n   }\n}\n"
- resource: "{\n  \"id\" : \"http://api.covisint.com/schema/resource\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"description\" : \"Core schema\",\n
    \ \"definitions\" : {\n    \"resource\" : {\n      \"id\" : \"resource\",\n      \"type\"
    : \"object\",\n      \"description\" : \"A basic resource.\",\n      \"properties\"
    : {\n        \"id\" : {\n          \"type\" : \"string\",\n          \"maxLength\"
    : 64,\n          \"description\" : \"The unique identifier for this resource.\",\n
    \         \"required\": true\n        },\n        \"version\": {\n          \"type\"
    : \"number\",\n          \"minimum\" : 0,\n          \"maximum\" : 9223372036854775807,\n
    \         \"description\" : \"The current version for this resource.  Exists once
    the resource has been saved. This is mandatory for PUT requests, but should not
    be supplied for POST requests.\",\n          \"required\": false\n        },\n
    \       \"creator\" : {\n          \"type\" : \"string\",\n          \"maxLength\"
    : 64,\n          \"description\" : \"The creator of this resource. This is mandatory
    if x-requestor header is NOT available\",\n          \"required\": false\n        },\n
    \       \"creatorAppId\" : {\n          \"type\" : \"string\",\n          \"maxLength\"
    : 64,\n          \"description\" : \"The application id of the creator of this
    resource.\",\n          \"required\": false\n        },\n        \"creation\"
    : {\n          \"type\" : \"number\",\n          \"minimum\" : 0,\n          \"maximum\"
    : 9223372036854775807,\n          \"description\" : \"If this value is provided
    in a POST / PUT request body, it will be ignored and system will generate value
    as time, in milliseconds since the epoch, when this resource was created or upda\",\n
    \         \"required\": false            \n        }\n      }\n    }\n  }\n}\n"
- realmScopedResource: |
    {
      "id" : "http://api.covisint.com/schema/realmScopedResource",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "object",
      "description" : "Expands on the base resource and adds a realm attribute.",
      "extends" : {
            "$ref" : "http://api.covisint.com/schema/resource#"
      },
      "properties" : {
        "realm" : {
          "type" : "string",
          "maxLength" : 25,
          "pattern" : "^[A-Za-z0-9]{2,25}$",
          "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available",
          "required": false
        }
      }
    }
- errorResponseSchema: "{\n  \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n  \"properties\"
    : {\n    \"status\" : { \n      \"type\" : \"number\",\n      \"minimum\" : 400,\n
    \     \"maximum\" : 599,\n      \"description\" : \"The HTTP status code.\",\n
    \     \"required\": true\n    },\n    \"apiMessage\" : { \n      \"type\" : \"string\",\n
    \     \"description\" : \"A helpful, human-readable description of the error,
    useful for basic diagnostics.\" \n    },\n    \"apiStatusCode\" : {\n      \"type\"
    : \"string\",\n      \"description\" : \"The API-specific status code.\"\n    }\n\n
    \ }\n}\n"
- serviceCode: "{\n  \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"type\": \"object\",\n  \"description\":
    \"The site/service/location codes granted along with a service.\",\n  \"properties\":
    {\n    \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200,
    \"description\": \"The code value.\" },\n    \"codeKind\": { \"type\": \"string\",
    \"required\": true, \"maxLength\": 36, \"description\": \"The associated business
    unit.\" }\n  }\n}     \n"
- serviceCodes: |
    {
      "type" : "array",
      "description" : "The site/service/location codes granted along with the service, if any.",
      "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"},
      "required": false
    }
- address: |
    {
      "id" : "http://api.covisint.com/idm/schema/address",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "object",
      "description" : "A container for the subject's address elements.",
      "properties" : {
        "type" : "string",
        "streets" : {
            "type" : "array",
            "description" : "An array of address streets (i.e. address line 1, 2, 3).",
            "minItems" : 0,
            "items" : {
              "type": "string",
              "maxLength" : 255
            }
          },
          "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." },
          "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." },
          "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." },
          "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"}
      }
    }
- phone: "{\n  \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n    \"description\"
    : \"A container for phone number details.\",\n    \"properties\" : {\n      \"number\"
    : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\"
    },\n      \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\"
    : \"The phone number type.\" }\n    },\n    \"required\" : [ \"type\" ]\n}             \n"
- internationalString: |
    {
      "id": "http://api.covisint.com/idm/schema/internationalString",
      "$schema": "http://json-schema.org/draft-04/schema",
      "type": "array",
      "description" : "An internationalized string value, supporting one or more language translations.",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." },
          "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." }
        }
      }
    }
- securityQuestions: |
    {
      "id" : "http://api.covisint.com/schema/securityQuestions/v2",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "array",
      "description": "Collection of security questions.",
      "items": {
        "$ref": "http://api.covisint.com/schema/securityQuestion/v2",
        "required": true
      }
    }
- securityQuestion: "{\n  \"id\" : \"http://api.covisint.com/schema/securityQuestion/v2\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"A representation of a security question.\",\n  \"extends\"
    : {\n    \"$ref\" : \"http://api.covisint.com/idm/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {\n    \"version\": {\n      \"description\" : \"The
    current version for this resource.  Exists once the resource has been saved. This
    is mandatory for PUT requests, but should not be supplied for POST requests. User
    supplied value will be ignored and will be set to the creation value.\"\n    },\n
    \   \"owner\": {\n      \"description\": \"The owner of this security question.
    Required only when creating or updating questions scoped to persons.  For realm
    and organization scoped questions, this property is not required.\",\n      \"$ref\":
    \"http://api.covisint.com/schema/resourceReference#\",\n      \"required\": false\n
    \   },\n    \"question\" : {\n      \"description\": \"Internationalized security
    question text.\",\n      \"required\": true,\n      \"minItems\": 0,            \n
    \     \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"            \n
    \   }\n  }\n}\n      \n"
- securityQuestionAccount: "{\n  \"id\" : \"http://api.covisint.com/schema/securityQuestionAccount/v2\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"A representation of a security question account.  An account
    is the pairing of zero or more question/answer that have been provided by the
    account holder.\",\n  \"extends\" : {\n    \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {\n    \"version\": {\n      \"description\" : \"The
    current version for this resource.  Exists once the resource has been saved. This
    is mandatory for PUT requests, but should not be supplied for POST requests. User
    supplied value will be ignored and will be set to the creation value.\"\n    },\n
    \   \"questions\": {\n      \"type\" : \"array\",\n      \"description\": \"The
    security questions chosen for this particular account.\",\n      \"required\":
    true,\n      \"minItems\": 0,\n      \"items\": {\n        \"type\": \"object\",\n
    \       \"properties\": {\n          \"question\": {\n            \"description\":
    \"The selected question.\",\n            \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n
    \           \"required\": true\n          },\n          \"answer\" : {\n            \"type\"
    : \"string\",\n            \"maxLength\" : 255,\n            \"description\" :
    \"The actual answer text, in the supplier's preferred locale.  Required only when
    creating or updating the security question account.\",\n            \"required\":
    false\n          },\n          \"index\" : {\n            \"type\" : \"number\",\n
    \           \"description\" : \"The logical order in which this question is to
    be viewed with respect to other questions used by this account. If provided, should
    be for all questions in a sequence starting with 1.\",\n            \"minValue\"
    : 1,\n            \"required\": false\n          }\n        }\n      }\n    }\n
    \ }\n}   \n"
- authenticationRequest: "{\n \"id\" : \"http://api.covisint.com/schema/authenticationRequest\",\n
    \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n
    \"description\" : \"Schema representing a authentication request resource.\",\n
    \"properties\" : {\n   \"instant\" : { \n     \"type\" : \"number\", \n     \"description\"
    : \"The time, in milliseconds since the epoch, when the authentication request
    is being made. if not provided, default current time in milliseconds will be set.\"\n
    \  },\n   \"subject\": {\n     \"type\": \"string\",\n     \"description\": \"The
    subject for which this request is being made. It can be either cuid or username.\",\n
    \    \"required\": true\n   },\n   \"subjectType\":{\n     \"type\": \"string\",\n
    \    \"enum\": [ \"CUID\", \"LOGIN_ID\"],\n     \"description\": \"The type of
    the subject.\",\n     \"required\": false, \n     \"default\": \"CUID\"\n   },\n
    \  \"password\": {\n     \"type\": \"string\",\n     \"description\": \"The password
    for the subject to validate.\",\n     \"required\": true\n   },\n   \"service\":
    {\n     \"type\": \"string\",\n     \"description\": \"The caller service description
    for the request.\",\n     \"maxLength\" : 128,\n     \"required\": true\n   },\n
    \  \"subjectInet\": {\n     \"type\": \"string\",\n     \"description\": \"The
    IP address of the caller service.\",\n     \"maxLength\" : 64,\n     \"required\":
    true\n  }\n }\n}\n      \n"
- authenticationResponse: "{\n  \"id\" : \"http://api.covisint.com/schema/authenticationResponse\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing a authentication response resource.\",\n
    \ \"properties\" : {\n    \"instant\" : { \n      \"type\" : \"number\", \n      \"description\"
    : \"The time, in milliseconds since the epoch, when the authentication took place.\"\n
    \   },\n    \"result\" : { \n      \"type\" : \"string\",\n      \"enum\" : [
    \"SUCCESS\", \"UNKNOWN_SUBJECT\", \"BAD_PASSWORD\",\"LOCKED\",\"EXPIRED\",\"ERROR\"
    ],\n      \"description\" : \"The status of the authentication request.\"\n    },\n
    \   \"request\": {\n      \"type\" : \"object\",\n      \"description\": \"The
    authentication request reference.\",\n      \"$ref\": \"http://api.covisint.com/idm/schema/authenticationRequest#\"\n
    \   },\n    \"personId\": {\n      \"type\" : \"string\",\n      \"description\":
    \"The cuid of the person. This will be returned only if the authentication result
    is SUCCESS.\"\n    }\n  }\n}\n"
- authenticationRule: "{\n  \"id\" : \"http://api.covisint.com/idm/schema/authenticationRule\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \   \"description\" : \"A container for authentication rule\",\n    \"properties\"
    : {\n      \"type\" : { \"enum\" : [ \"PasswordLockout\"], \"description\" : \"The
    authentication rule type.\" }\n    },\n    \"required\" : [ \"type\" ]\n} \n"
- passwordLockoutRule: "{\n  \"id\" : \"http://api.covisint.com/idm/schema/passwordLockoutRule\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \   \"description\" : \"History rule for password policy\",\n    \"extends\" :
    {\"$ref\" : \"http://api.covisint.com/schema/authenticationRule#\"\n      },\n
    \   \"properties\" : {\n      \"failures\" : {\"type\" : \"number\",\"description\"
    : \"The number of failures that can occur, with the failure lockout period, before
    a password credential is locked.\", \"required\": false, \"default\":3\n      },\n
    \     \"failureWindow\" : {\"type\" : \"number\",\"description\" : \"The amount
    of time, in minutes, within which a set number of failures must occur for a password
    credential to be locked\", \"required\": false, \"default\":5\n      },\n      \"lockoutWindow\"
    : {\"type\" : \"number\",\"description\" : \"The amount of time, in minutes, before
    a password that was locked due to too many failed authentication attempts is automatically
    unlocked.\", \"required\": false, \"default\":15\n      }\n    }\n}    \n   \n"
- authenticationPolicy: "{\n  \"id\" : \"http://api.covisint.com/schema/authenticationPolicy\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing an authentication policy resource.\",\n
    \ \"extends\" : {\n        \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {\n    \"status\" : { \n      \"type\" : \"string\",\n
    \     \"enum\" : [ \"active\", \"inactive\", \"deleted\" ],\n      \"description\"
    : \"The status of the authentication policy.\",\n      \"required\": true\n    },\n
    \   \"name\" : {\n      \"type\" : \"string\",\n      \"description\": \"The name
    of authentication Policy.\",\n      \"required\": true\n    },\n    \"desc\":
    {\n      \"type\" : \"string\",\n      \"description\": \"The description for
    authentication Policy.\"\n    },                                  \n     \"rules\"
    : {\n       \"type\" : \"array\",\n       \"description\" : \"Authentication Policy
    Rules\",\n       \"minItems\" : 1,\n       \"items\" : { \"$ref\" : \"http://api.covisint.com/idm/schema/authenticationRule#\"
    },\n       \"required\": true\n    }\n  }\n}\n"
- passwordRule: "{\n  \"id\" : \"http://api.covisint.com/idm/schema/passwordRule\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \   \"description\" : \"A container for password rule\",\n    \"properties\" :
    {\n      \"type\" : { \"enum\" : [ \"history\", \"lifetime\", \"character_class\",
    \"disallowed_words\", \"disallowed_characters\", \"length\"], \"description\"
    : \"The password rule type.\" }\n    },\n    \"required\" : [ \"type\" ]\n} \n"
- historyRule: |
    {
      "id" : "http://api.covisint.com/idm/schema/historyRule",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "object",
        "description" : "History rule for password policy",
        "extends" : {"$ref" : "http://api.covisint.com/schema/passwordRule#"
          },
        "properties" : {
          "numberOfPasswords" : {"type" : "number","description" : "History for passwords to maintain", "required": true
          }
        }
    }
- lifetimeRule: "{\n  \"id\" : \"http://api.covisint.com/idm/schema/lifetimeRule\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \   \"description\" : \"Lifetime rule for password policy\",\n    \"extends\"
    : {\"$ref\" : \"http://api.covisint.com/schema/passwordRule#\"\n      },\n    \"properties\"
    : {\n      \"minPasswordLifetime\" : {\"type\" : \"number\",\"description\" :
    \"The minimum amount of time, in days, that must pass between password changes.\",
    \"required\": true\n      },\n      \"maxPasswordLifetime\" : {\"type\" : \"number\",\"description\"
    : \"The maximum time, in days, that a password can exist before it is changed\",
    \"required\": true\n      }\n    }\n} \n"
- characterClassRule: |
    {
      "id" : "http://api.covisint.com/idm/schema/characterClassRule",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "object",
        "description" : "Character class rule for password policy",
        "extends" : {"$ref" : "http://api.covisint.com/schema/passwordRule#"
          },
        "properties" : {
          "allowUpperChars" : {"type" : "boolean","description" : "If password policy allows uppercase chars.", "required": true
          },
          "allowLowerChars" : {"type" : "boolean","description" : "If password policy allows lowercase chars.", "required": true
          },
          "allowNumChars" : {"type" : "boolean","description" : "If password policy allows numbers.", "required": true
          },
          "allowSpecialChars" : {"type" : "boolean","description" : "If password policy allows special chars.", "required": true
          },
          "requiredNumberOfCharClasses" : {"type" : "boolean","description" : "If password policy requires numbers.", "required": true
          }
        }
    }
- disallowedWordsRule: |
    {
      "id" : "http://api.covisint.com/idm/schema/disallowedWordsRule",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "extends" : {"$ref" : "http://api.covisint.com/schema/passwordRule#"
          },
      "type" : "object",
        "description" : "Disallowed words rule for password policy",
        "properties" : {
          "wordListId" : {"type" : "number","description" : "Unique identifier of the disallowed word list", "required": true
          }
        }
    }
- disallowedCharsRule: |
    {
      "id" : "http://api.covisint.com/idm/schema/disallowedCharsRule",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "extends" : {"$ref" : "http://api.covisint.com/schema/passwordRule#"
          },
      "type" : "object",
        "description" : "Disallowed chars rule for password policy",
        "properties" : {
          "disallowedChars" : {"type" : "string","description" : "Disallowed characters in the password", "required": true
          }
        }
    }
- lengthRule: |
    {
      "id" : "http://api.covisint.com/idm/schema/lengthRule",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "extends" : {"$ref" : "http://api.covisint.com/schema/passwordRule#"
          },
      "type" : "object",
        "description" : "Length rule for password policy",
        "properties" : {
          "min" : {"type" : "number","description" : "Minimum length of the password alowed.", "required": true
          },
          "max" : {"type" : "number","description" : "Maximum length of the password alowed.", "required": true
          }
        }
    }
- passwordPolicy: "{\n  \"id\" : \"http://api.covisint.com/schema/passwordPolicy\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing an password policy resource.\",\n  \"extends\"
    : {\n    \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {\n    \"status\" : { \n      \"type\" : \"string\",\n
    \     \"enum\" : [ \"active\", \"inactive\", \"deleted\" ],\n      \"description\"
    : \"The status of the password policy.\",\n      \"required\": true\n    },\n
    \   \"name\" : {\n      \"type\" : \"string\",\n      \"description\": \"The name
    of password Policy.\",\n      \"required\": true\n    },\n    \"desc\": {\n      \"type\"
    : \"string\",\n      \"description\": \"The description for password Policy.\"\n
    \   },                                  \n    \"rules\" : {\n       \"type\" :
    \"array\",\n       \"description\" : \"Password Policy Rules\",\n       \"minItems\"
    : 0,\n       \"items\" : { \"$ref\" : \"http://api.covisint.com/idm/schema/passwordRule#\"
    },\n       \"required\": false\n    }\n  }\n}\n"
- password: "{\n  \"id\" : \"http://api.covisint.com/schema/password\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n  \"description\"
    : \"Schema representing an password resource.\",\n  \"extends\" : {\n    \"$ref\"
    : \"http://api.covisint.com/idm/schema/realmScopedResource#\"\n  },\n  \"properties\"
    : {\n    \"subject\": { \n      \"description\": \"The subject for which this
    password resource belongs to.\",\n      \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n
    \     \"required\": true\n    },\n    \"password\": {\n      \"type\" : \"string\",\n
    \     \"description\": \"The password string for the subject. When a password
    is sent in the body of a request, this property is used to transport the desired
    password.\"\n    },\n    \"hashAlgorithm\": {\n      \"type\" : \"string\",\n
    \     \"description\": \"The algorithm which this password is hashed with. This
    property along with 'hashedPassword' is used to represent the stored password,
    when a password resource is returned in the response body.\"\n    },\n    \"hashedPassword\":
    {\n      \"type\" : \"string\",\n      \"description\": \"The subject's new password,
    hashed. This property along with 'hashAlgorithm' is used to represent the stored
    password, when a password resource is returned in the response body.\"\n    },\n
    \   \"passwordPolicyId\" : { \n      \"type\" : \"string\", \n      \"description\"
    : \"The unique identifier for the password policy governing the password.\",\n
    \     \"required\": true\n    },\n    \"authenticationPolicyId\" : { \n      \"type\"
    : \"string\", \n      \"description\" : \"The unique identifier for the authentication
    policy governing the password.\",\n      \"required\": true\n    },\n    \"expiration\"
    : { \n      \"type\" : \"number\", \n      \"description\" : \"The time, in milliseconds
    since the epoch, when the password expires.\"\n    },\n    \"locked\" : {\n      \"type\"
    : \"boolean\",\n      \"description\" : \"Whether or not the password is locked.\"\n
    \   },\n    \"unlockInstant\" : { \n      \"type\" : \"number\", \n      \"description\"
    : \"The time, in milliseconds since the epoch, when the password will be unlocked.\"\n
    \   }\n  }\n}\n"
- passwordValidation: |
    {
      "id" : "http://api.covisint.com/schema/passwordValidation",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "object",
      "description" : "Schema representing an password validation.",
      "properties" : {
        "name" : {
          "type" : "array",
          "description": "Represents password validation response.",
          "required": true,
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "type": { "type": "string" },
              "description": { "type": "string", "maxLength": 2000 },
              "passed": { "type": "boolean", "required": true }
            }
          }
        }
      }
    }
- pin: "{\n  \"id\" : \"http://api.covisint.com/schema/pin\",\n  \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n
    \ \"type\" : \"object\",\n  \"description\" : \"Schema representing an pin resource.\",\n
    \ \"extends\" : {\n    \"$ref\" : \"http://api.covisint.com/idm/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {\n    \"pin\": { \n      \"type\" : \"string\",\n      \"description\":
    \"The pin string for pin resource.\",\n      \"required\": true\n    }\n  }\n}\n
    \   \n"
traits:
- secured:
    usage: Apply this to any method that needs to be secured
    description: Requests requires authentication using a bearer token.
    headers:
      Authorization:
        description: Access token that is obtained from the /token endpoint of the
          oauth API.
        pattern: "^Bearer .*$"
        example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk
        required: true
    responses:
      401:
        description: Unauthenticated request.  This is returned if the access token
          is missing, invalid, or expired.  Access tokens are obtained through the
          /token endpoint of the Oauth API.
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      403:
        description: Unauthorized request.  The requestor is not authorized to perform
          the requested operation.
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
- getResponse:
    responses:
      404: &3
        description: |
          The URI requested is invalid or the resource requested does not exist.
          ___
          Substatus codes and error messages are mentioned below:
          + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId}
          + No message for an invalid URI
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      406: &1
        description: |
          Unable to produce content of specified 'Accept' media type
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      500: &2
        description: |
          An unknown server error occurred
          ___
          Substatus codes and error messages are mentioned below:
          + framework:unknown
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
- getSearchResponse:
    responses:
      406: *1
      500: *2
- postResponse:
    responses:
      406: *1
      415: &4
        description: |
          Unable to consume content of specified 'Content-Type' media type
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      500: *2
- deleteResponse:
    responses:
      500: *2
- putResponse:
    responses:
      404: *3
      406: *1
      409: &5
        description: |
          There is a conflict in identifying the resource being acted on.  There are two categories.  (1) The unique identifier in the URL and in the body are different.  (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource.
          + framework:resource:conflict
          + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId}
          + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      415: *4
      500: *2
- putCreateResponse:
    responses:
      406: *1
      409: *5
      415: *4
      500: *2
- pagableRequest:
    queryParameters:
      page:
        description: Which page to return in the paginated results.  The first page
          is page 1.
        type: integer
        required: false
        minimum: 1
        default: 1
      pageSize:
        description: How many items per page in the paginated results.
        type: integer
        required: false
        minimum: 1
        default: 50
        maximum: 200
"/securityQuestions":
  is:
  - secured
  description: Endpoint for security questions used to verify a person's account.
  get:
    is:
    - getSearchResponse
    - pagableRequest
    description: Search for available security questions.  If the owner query parameters
      are not specified, then all available security questions will be returned.
    headers:
      Accept:
        description: Media type for a security question resource.
        example: application/vnd.com.covisint.platform.securityquestion.v1+json
        type: string
        required: true
    queryParameters:
      owner.id:
        description: Filter on the id of the resource owning the question. For example,
          the person id or organization id.  This query parameter is only required
          if owner.type is specified.
        type: string
        required: false
      owner.type:
        description: Filter on the type of the resource owning the question.  For
          example, person or organization.  This query paramer is only required if
          owner.id is specified.
        type: string
        required: false
    responses:
      200:
        description: All matching security questions were successfully retrieved.
        body:
          application/vnd.com.covisint.platform.securityquestion.v1+json:
            schema: securityQuestions
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + securityquestions.multiple.owner.id.invalid - Muliple owner ids {ownerId(s)} are not allowed
          + securityquestions.multiple.owner.type.invalid - Muliple owner types {ownerId(s)} are not allowed
          + securityquestions.owner.id.invalid - Owner id {ownerId} invalid if owner type is not mentioned
          + securityquestions.owner.type.invalid - Owner type {ownerType} invalid if owner id is not mentioned
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  "/{id}":
    description: Endpoint for security questions of a specific user.
    uriParameters:
      id:
        description: The unique id of the person.
        type: string
        required: true
    is:
    - secured
    put:
      is:
      - putResponse
      description: Updates a security question, creating it when it doesn't exist.  Currently,
        only person-scoped security questions are supported.  Clears the person scoped
        question if an empty question array is supplied. In all the scenarios, the
        person scoped answer gets overwritten.
      headers:
        Accept:
          description: Media type for a person security question account.
          example: application/vnd.com.covisint.platform.securityquestion.v1+json
          type: string
          required: true
      body:
        application/vnd.com.covisint.platform.securityquestion.v1+json:
          schema: securityQuestion
      responses:
        200:
          description: The person scoped question was updated successfully (or created
            if it didn't already exist).
          body:
            application/vnd.com.covisint.platform.securityquestion.v1+json:
              schema: securityQuestion
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes and error messages are mentioned below:
            + framework:request
            + framework:request:io
            + framework:request:io:read - Invalid input. There was an error while parsing.
            + framework:request:io:read:parsing
            + framework:request:io:write
            + framework:request:header:missing - Missing request header: {headerName}
            + framework:resource:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
            + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
            + security.question.invalid.owner.type - Invalid owner type for challenge question. Valid value is: person
            + security.question.one.question.text.allowed - Only 1 question text is allowed
            + security.question.challenge.question.not.allowed - Challenge question is not allowed
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
            + framework:resource:missing - The following resources were not found: {resources}
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
"/persons/{personId}/accounts/securityQuestion":
  is:
  - secured
  get:
    is:
    - getResponse
    description: Returns the person's security question account.
    headers:
      Accept:
        description: Media type for a person security question account.
        type: string
        required: true
        example: application/vnd.com.covisint.platform.person.account.securityQuestion.v1+json
    responses:
      200:
        description: The person's chosen security questions were successfully retrieved.
        body:
          application/vnd.com.covisint.platform.person.account.securityQuestion.v1+json:
            schema: securityQuestionAccount
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:resource:missing  - A resource with the following ID was not found: {resourceId}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  put:
    is:
    - putResponse
    description: Updates a person's security questions account (or creates one if
      it doesn't exist).
    headers:
      Accept:
        description: Media type for a person security question account.
        example: application/vnd.com.covisint.platform.person.account.securityQuestion.v1+json
        type: string
        required: true
    body:
      application/vnd.com.covisint.platform.person.account.securityQuestion.v1+json:
        schema: securityQuestionAccount
    responses:
      200:
        description: The person's security question account was updated successfully
          (or created if it didn't already exist).
        body:
          application/vnd.com.covisint.platform.person.account.securityQuestion.v1+json:
            schema: securityQuestionAccount
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:resource:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
          + security.question.account.invalid.fixed.questions - Only {count} unique fixed questions are allowed
          + security.question.account.invalid.fixed.question.index - Set unique index for all fixed questions in a sequence starting with '1' OR do not set index for any question
          + security.question.account.invalid.challenge.question- Only {count} challenge question(s) are allowed
          + security.question.account.invalid.fixed.question.id.format - Invalid fixed question id format. Valid format is 'realmId:questionId', where questionId is a number
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema