REST API Reference

SIS – Users

GetUserExpiration

GetUserExpiration
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/SIS.svc/user/[userName]/expiration?serviceKey=[serviceKey]
Method	GET
Accept	application/json

Request

null

Response

2018-03-14T20:01:15.51

GetSecurityQuestions

GetSecurityQuestions
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/SIS.svc/securityquestions
Method	GET
Authentication	Session token set as Username on Authenication header.
Accept	application/json

Request

null

Response

[
  {
    "QuestionCode": "MotherMaiden",
    "QuestionText": "What is your mother's maiden name?"
  },
  {
    "QuestionCode": "SpouseCity",
    "QuestionText": "In what city or town did you meet your spouse/partner?"
  }
]

GetAvailableSecurityQuestions

GetAvailableSecurityQuestions
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/SIS.svc/availablesecurityquestions
Method	GET
Authentication	Session token set as Username on Authenication header.
Accept	application/json

Request

null

Response

[
  {
    "QuestionCode": "MotherMaiden",
    "QuestionText": "What is your mother's maiden name?"
  },
  {
    "QuestionCode": "SchoolMascot",
    "QuestionText": "What is the name of high school mascot?"
  },
  {
    "QuestionCode": "FirstPet",
    "QuestionText": "What is the name of your first pet?"
  },
  {
    "QuestionCode": "ChildhoodFriend",
    "QuestionText": "What is the name of your favorite childhood friend?"
  },
  {
    "QuestionCode": "SpouseFather",
    "QuestionText": "What is the first name of your spouse's father?"
  },
  {
    "QuestionCode": "SpouseCity",
    "QuestionText": "In what city or town did you meet your spouse/partner?"
  },
  {
    "QuestionCode": "MotherFather",
    "QuestionText": "In what city or town did your mother and father meet?"
  },
  {
    "QuestionCode": "JobCity",
    "QuestionText": "In what town or city was your first full time job?"
  },
  {
    "QuestionCode": "FirstCar",
    "QuestionText": "What is the model of your first car?"
  },
  {
    "QuestionCode": "FirstSchool",
    "QuestionText": "What is the name of your first school?"
  },
  {
    "QuestionCode": "SixthGrade",
    "QuestionText": "What school did you attend for sixth grade?"
  },
  {
    "QuestionCode": "HouseChild",
    "QuestionText": "What was the house number and street name you lived in as a child?"
  },
  {
    "QuestionCode": "FirstJob",
    "QuestionText": "What was the name of the company where you had your first job?"
  },
  {
    "QuestionCode": "HospitalBirth",
    "QuestionText": "What was the name of the hospital where you were born?"
  },
  {
    "QuestionCode": "FirstToy",
    "QuestionText": "What was the name of your first stuffed animal or doll or action figure?"
  },
  {
    "QuestionCode": "NewYear2000",
    "QuestionText": "Where were you New Year's 2000?"
  },
  {
    "QuestionCode": "SportHero",
    "QuestionText": "Who is your childhood sports hero?"
  },
  {
    "QuestionCode": "ChildHero",
    "QuestionText": "Who was your childhood hero?"
  }
]

ChangeUserInformation

ChangeUserInformation
RequestUri	https://api.cipcert.goevo.com/2.1.28/REST/SIS.svc/user/[userName]?serviceKey=[serviceKey]
Method	PUT
Accept	application/json

Request

{
  "UserName": null,
  "Password": null,
  "Email": null,
  "SecurityAnswers": [
    {
      "QuestionCode": "MotherMaiden",
      "Answer": "Doe"
    },
    {
      "QuestionCode": "SpouseCity",
      "Answer": "Denver"
    }
  ],
  "SecurityQuestionToken": null,
  "SecurityAnswer": null
}

Response

ListUserCredentials

ListUserCredentials
RequestUri	https://us002-dv-cip01.evosnap.local/2.1.29/REST/Administration.svc/users/list
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

{
  "$type": "UserQuery, http://schemas.evosnap.com/CWS/v2.0/Administration",
  "PagingParameters": {
    "Page": 0,
    "PageSize": 10
  },
  "UserQueryParameters": {
    "Region": "region",
    "SalesChannel": "sales channel",
    "ServiceKey": "service key",
    "Merchant": "merchnat",
    "FirstName": "first name",
    "0": "last name",
    "Email": "test@test.com",
    "Username": "username",
    "LockState": "0"
  },
  "SortField": "0",
  "SortType": "0"
}

GetRolesClaims

GetRolesClaims
RequestUri	https://us002-dv-cip01.evosnap.local/2.1.29/REST/Administration.svc/roleClaims
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null

Response

 [
{
"Claims": [],
"RoleName": "test role name"
},
{
"Claims": [],
"RoleName": "CWSCompleteClient"
},
{
"Claims": [
{
"ClaimDescription": "MySnap Access Claim ",
"ClaimNS": "http://schemas.mysnap.com/claims/Settings/Roles",
"ClaimScope": {
"AllowableIdentityTypes": null,
"ScopeId": 18,
"ScopeName": "MySnap"
},
"ClaimType": 4,
"ClaimValue": "Enable"
},
{
"ClaimDescription": "MySnap Access Claim ",
"ClaimNS": "http://schemas.mysnap.com/claims/Settings/UserProfileModule/Current",
"ClaimScope": {
"AllowableIdentityTypes": null,
"ScopeId": 18,
"ScopeName": "MySnap"
},
"ClaimType": 4,
"ClaimValue": "Add"
},
   . . . 
{
"Claims": [],
"RoleName": "ConsumerUser"
}
]

GetChildRoles

GetChildRoles
RequestUri	https://us002-dv-cip01.evosnap.local/2.1.29/REST/Administration.svc/childRoles
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null

Response

[
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "EnterpriseUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "RegionalAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "RegionalUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "ISVAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "ISVUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "RegionalAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "RegionalUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "ISVAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "ISVUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "RegionalUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "SalesChannelUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "ISVUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantAdmin",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MerchantUser",
        "Scope": "FederatedSecurity"
    },
    {
        "Description": null,
        "RoleGuid": null,
        "RoleName": "MasterMerchantUser",
        "Scope": "FederatedSecurity"
    }
]

ListScopes

ListScopes
RequestUri	https://us002-dv-cip01.evosnap.local/2.1.29/REST/Administration.svc/scopes
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null

Response

[
  {
    "ScopeId": 2,
    "ScopeName": "TransactionProcessing",
    "AllowableIdentityTypes": [
      "System",
      "User",
      "SystemMerchant",
      "SystemISV"
    ]
  },
  {
    "ScopeId": 3,
    "ScopeName": "Global",
    "AllowableIdentityTypes": [
      "Windows",
      "SystemRelyingParty"
    ]
  },
  {
    "ScopeId": 4,
    "ScopeName": "IPC-Public",
    "AllowableIdentityTypes": []
  },
  {
    "ScopeId": 6,
    "ScopeName": "IPC-Sandbox",
    "AllowableIdentityTypes": [
      "Windows",
      "User"
    ]
  },
  {
    "ScopeId": 8,
    "ScopeName": "KeyManagement",
    "AllowableIdentityTypes": [
      "User"
    ]
  },
  {
    "ScopeId": 13,
    "ScopeName": "EHS",
    "AllowableIdentityTypes": []
  },
  {
    "ScopeId": 14,
    "ScopeName": "Mercury",
    "AllowableIdentityTypes": []
  },
  {
    "ScopeId": 17,
    "ScopeName": "FederatedSecurity",
    "AllowableIdentityTypes": [
      "SystemRegion",
      "User",
      "SystemSalesChannel"
    ]
  },
  {
    "ScopeId": 18,
    "ScopeName": "MySnap",
    "AllowableIdentityTypes": []
  }
]

ListRoles

ListRoles
RequestUri	https://us002-dv-cip01.evosnap.local/2.1.29/REST/Administration.svc/roles/list/13
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null

Response

[
  {
    "RoleGuid": null,
    "RoleName": "CWSCompleteClient",
    "Description": "Access to all CWS Endpoints and Operations",
    "Scope": "EHS"
  }
]

RemoveRoleFromUserCredential

RemoveRoleFromUserCredential
RequestUri	https://us002-dv-cip01.evosnap.local/2.1.29/REST/Administration.svc/users/C8DC44D6434C48A4904D1D74EC606D57/removeRole/MasterMerchantAdmin
Method	POST
Authentication	Session token set as Username on Authentication header.
Accept	application/json

Request

null