The page has been translated by Gen AI.

Open API Guides

SingleID Open API Guides

To use the SCP SingleID Open API, the system must be registered as an Application first. The registered system information is used to issue a JWT Token, which must be included in the HTTP header when calling the SCP SingleID Open API.

API Calling Method

  1. Call with the token (JWT Token) value included in the HTTP header
  2. Set the access token header name to Authorization and the access token type value to Bearer - set the JWT Token value after the Bearer string.
  3. Environment information for testing
    • domain :
      • Internal: stg-scloud.iam.samsung.net
      • External: stg2-cloud.singleid.samsung.net
    • tenant-name : test-tenant
  4. Test Swagger UI URL

API List

ModuleAPIURIMethodDescription
Portal CommonGet MFA Tokenhttps://{domain}/{tenant-name}/common-api/open/v1.1/asis/{tenant-name}/user/mfa/token/authenticationGETIssue MFA Token
Portal CommonOTP Sendhttps://{domain}/{tenant-name}/common-api/open/v1.1/asis/otp/sendPOSTCreate OTP based on authentication type (email, SMS, message)
Portal CommonOTP Validationhttps://{domain}/{tenant-name}/common-api/open/v1.1/asis/otp/validatePOSTValidate OTP
Portal CommonMFA Consumer Requesthttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/requestGETRequest MFA
Portal CommonMFA Consumer Requesthttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/requestPOSTRequest MFA
Tenant Admin PortalSend Email about Anomaly Detectionhttps://{domain}/{tenant-name}/admin-api/open/v1.1/emails/anomalyDetectionPOSTSend email to user when anomaly detection occurs
Tenant Admin PortalSend Email about New Sign-in Environmenthttps://{domain}/{tenant-name}/admin-api/open/v1.1/emails/newSignInEnvironmentPOSTSend confirmation email to user when signing in to a new environment
User PortalGet Userhttps://{domain}/{tenant-name}/user-api/open/v1.1/users/{username}GETRetrieve user’s username, email, preferred language, and timezone
User PortalGet User Profile Imagehttps://{domain}/{tenant-name}/user-api/open/v1.1/users/image/{username}GETRetrieve user’s profile image
User PortalCreate account assignment listhttps://{domain}/{tenant-name}/user-api/1.0/scp-auth/createPOSTCreate user’s SCP permission
User PortalDelete account assignment listhttps://{domain}/{tenant-name}/user-api/1.0/scp-auth/deletePOSTDelete user’s SCP permission
User PortalGet account assignment listhttps://{domain}/{tenant-name}/user-api/1.0/scp-auth/listGETRetrieve user’s SCP permission
User PortalSearch Userhttps://{domain}/{tenant-name}/user-api/1.0/scp-user/listGETSearch for SCP target users
Portal CommonMFA Consumer Requesthttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/request/mfaPOSTRequest MFA (including device)
Portal CommonMFA Consumer Verificationhttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/verification/mfaPOSTVerify MFA (including device)
Table. API list

API Specification - Get MFA Token (Portal Common)

ModuleAPIURIMethodDescription
Portal CommonGet MFA Tokenhttps://{domain}/{tenant-name}/common-api/open/v1.1/asis/{tenant-name}/user/mfa/token/authenticationGETIssue MFA Token
Table. Get MFA Token (Portal Common)

Request Parameters

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
Tenant Nametenant-nameYPathStringtest-tenant
User NameuserNameYqueryStringmkdir.kim
ProtocolprotocolYqueryStringuma-uaf
sessionDataKeysessionDataKeyNqueryStringsessionDataKey1
redirectUrlredirectUrlNqueryStringredirectUrl1
errorRedirectUrlerrorRedirectUrlNqueryStringerrorRedirectUrl1
paramsparamsNqueryStringparams1
languagelanguageNqueryStringko
Table. Request Parameters

Response Parameters

Properties (Result)AttributeData TypeSample DataNote
ResultresultStringSUCCESS
Result ValuevalueObject{
"token": "eyJpc3MiOiJodHRwczov...",
"serviceUri": "/ua/MPHTOCHW5I/de6f67d0-8bec-46ac-bf53-16ef00eb2066/dgauth/mfa"
}
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg-scloud.singleid.samsung.net:443/stg4/user-api/1.0/scp-auth/delete" -H "accept: application/json"-H "apiKey: {apiKey}" INPUT JSON{     "instanceId": "instnace-01",     "permissionSetId":   "PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf",     "principalId": "singleid.test001",     "principalType": "USER",     "targetId": "PROJECT-ka2tfhLHsweVwm4BrR1rae",     "targetType": "PROJECT"   }{   "instanceId": "instnace-01",   "permissionSetId": "PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf",   "principalId": "singleid.test001",   "principalType": "USER",   "targetId": "PROJECT-ka2tfhLHsweVwm4BrR1rae",   "targetType": "PROJECT"   "status": "SUCCESS",   "createdDate": "2024-04-03T01:58:46.538Z",   "failureReason": "" }
Table. Sample

Error Code

HTTP Response CodeError CodeError MessageAction Required
400N/AN/AUser name verification required
Table. Error Code

API Specification - OTP Send(Portal Common)

ModuleAPIURIMethodDescription
Portal CommonOTP Sendhttps://{domain}/{tenant-name}/common-api/open/v1.1/asis/otp/sendPOSTCreate OTP based on authentication type (email, sms, msg)
Table. OTP Send(Portal Common)

Request Parameters

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
localelocaleYbodyStringen
authentication typetypeYbodyStringemail, sms, msg
userNameuserNameYbodyStringgildong.hong
Table. Request Parameters

Response Parameters

PropertiesAttributeData TypeSample DataNote
otpStringotpStringString0000000c5bb286c166530ac928d0bdf1f0894ed3a6d891eb3ab7ec89fc9faef7817b9f2f02f8c89ae91558cdc9afec94d6bede93a91d9825f4fe14dc2a282f6456d09f823d194570bc91b353830826e69d5f818172c12dbdb7b524
Table. Response Parameters

Sample

RequestResponse
ccurl -X POST "https://localhost:7443/open/v1.1/asis/otp/send" -H "accept: */*" -H "Content-Type: application/json" -d "{\"locale\":\"ko\",\"type\":\"email\",\"userName\":\"gildong.hong\"}"{ "otpString": 0000000c5bb286c166530ac928d0bdf1f0894ed3a6d891eb3ab7ec89fc9faef7817b9f2f02f8c89ae91558cdc9afec94d6bede93a91d9825f4fe14dc2a282f6456d09f823d194570bc91b353830826e69d5f818172c12dbdb7b524}
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
404N/AN/AWhen the user does not exist
429N/AN/ADuplicate calls within 60 seconds
500N/AN/AServer error, check error message and contact administrator
Table. Error Code

API Specification - OTP Validation(Portal Common)

ModuleAPIURIMethodDescription
Portal CommonOTP Validationhttps://{domain}/{tenant-name}/common-api/open/v1.1/asis/otp/validatePOSTValidates the OTP.
Table. OTP Validation(Portal Common)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
userNameuserNameYBodyStringgildong.hong
otp(6 digits)otpYBodyString121215
checkValuecheckValueYBodyString0000000c5bb286c166530ac928d0bdf1f0894ed3a6d891eb3ab7ec89fc9faef7817b9f2f02f8c89ae91558cdc9afec94d6bede93a91d9825f4fe14dc2a282f6456d09f823d194570bc91b353830826e69d5f818172c12dbdb7b524sendOtp response otpString value
Authentication TypetypeYBodyStringemailemail, sms, msg
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
ResultresultStringSUCCESS
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://localhost:7443/open/v1.1/asis/otp/validate" -H "accept: */*" -H "Content-Type: application/json" -d "{\"checkValue\":\"0000000c5bb286c166530ac928d0bdf1f0894ed3a6d891eb3ab7ec89fc9faef7817b9f2f02f8c89ae91558cdc9afec94d6bede93a91d9825f4fe14dc2a282f6456d09f823d194570bc91b353830826e69d5f818172c12dbdb7b524\",\"otp\":\"791462\",\"type\":\"email\",\"userName\":\"gildong.hong\"}"{ "result": "success" }
Table. Sample

Error Code

Http Response CodeError CodeError MessageCountermeasure
400N/AN/AWhen OTP is entered incorrectly
404N/AN/AWhen the user does not exist
410N/AN/AWhen OTP has expired
429N/AN/AWhen API call fails more than 10 times
500N/AN/AServer error, check error message and contact administrator
Table. Error Code

API Specification - MFA Consumer Request(Portal Common)

ModuleAPIURIMethodDescription
Portal CommonMFA Consumer Requesthttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/requestGETRequests MFA.
Table. MFA Consumer Request(Portal Common)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
JWT TokenjwtTokenRequestYqueryStringeyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiJqaW5vbmUua2ltIiwiZGlzcGxheVVpZCI6Imppbm9uZS5raW1Ac2Ftc3VuZy5jb20iLCJlbWFpbCI6ImxUL3p4WngxNk81REo2SU91Z2VnRW9wVGk2eDh5bkxXY3NHLzRaWFE2TVlDSzNQV05oTS9hQUFnQmpkSEJMN1hkcFA2Y25jNCIsIm1vYmlsZSI6InlkVU54ZVl6YkNOY0xEYnFqN01rL2ZCdFcvaHZoRE1Bbm9lNzhRVTRvQTAzZUlwN2NsOVFpSGFoIiwicnRuIjoiaHR0cHM6Ly9zdGcxLWNsb3VkLnNpbmdsZWlkLnNhbXN1bmcubmV0L21vY2svcW1zL21mYS1jb25zdW1lci9yZXN1bHQiLCJyZXEiOiI3NjFlZmQ1Mi05N2QwLTQ1MWYtOWNmOS1jZjg2NzQwZTdjYTMiLCJzeXMiOiI4MDE0ODYyMS04MjZmLTQ5YmUtOGM5ZS0zMTE1ZTUzMDFlMWIiLCJuYmYiOjE3MTIwMjkxNDIsImV4cCI6MTcxNDYyMTE0MiwiaWF0IjoxNzEyMDI5MTQyfQ.-FWTK4IJsu8AonfJTTq7_OA1qAh-9FU89iC1JZcRg_cOriginal token sample data
{ "sys":"test-system", "req":"761efd52-97d0-451f-9cf9-cf86740e7ca3", "uid":"gildong.hong", "rtn":"https://test.com/mfa/response","email":"gildong.hong@samsung.com","mobile":"+82-1012345678", "nbf": 1698232068, "exp": 1698239268, "iat": 1698232068, "displayUid": "gildong.hong@samsung.com" }
Table. Request Parameters

Response

MFA authentication page is redirected. By default, the response token is delivered in the post method, but if you want to deliver it in the get method (query), add the following parameters to the request token:

  • returnMethod: get

Sample

RequestResponse
curl -X GET "https://stg2-cloud.singleid.samsung.net/test-tenant/common-api/open/v1.1/mfa/request?jwtTokenRequest=eyJhbGciOiJIUzI1NiJ9.eyJzeXMiOiJ0ZXN0LXN5c3RlbSIsInJlcSI6Ijc2MWVmZDUyLTk3ZDAtNDUxZi05Y2Y5LWNmODY3NDBlN2NhMyIsInVpZCI6Imppbm9uZS5raW0iLCJydG4iOiJodHRwczovL3Rlc3QuY29tL21mYS9yZXNwb25zZSIsIm5iZiI6MTY5ODIzMjA2OCwiZXhwIjoxNjk4MjM5MjY4LCJpYXQiOjE2OTgyMzIwNjh9.cDgKMHIINaHhBiyAd_OIlVvQwmUs0QaXH_RfJ8B_KdY"Page moved
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
400N/AN/ACheck the token data.
Table. Error Code

API Specification - MFA Consumer Request(Portal Common)

ModuleAPIURIMethodDescription
Portal CommonMFA Consumer Requesthttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/requestPOSTRequests MFA.
Table. MFA Consumer Request(Portal Common)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
JWT TokenjwtTokenRequestYqueryStringeyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiJqaW5vbmUua2ltIiwiZGlzcGxheVVpZCI6Imppbm9uZS5raW1Ac2Ftc3VuZy5jb20iLCJlbWFpbCI6ImxUL3p4WngxNk81REo2SU91Z2VnRW9wVGk2eDh5bkxXY3NHLzRaWFE2TVlDSzNQV05oTS9hQUFnQmpkSEJMN1hkcFA2Y25jNCIsIm1vYmlsZSI6InlkVU54ZVl6YkNOY0xEYnFqN01rL2ZCdFcvaHZoRE1Bbm9lNzhRVTRvQTAzZUlwN2NsOVFpSGFoIiwicnRuIjoiaHR0cHM6Ly9zdGcxLWNsb3VkLnNpbmdsZWlkLnNhbXN1bmcubmV0L21vY2svcW1zL21mYS1jb25zdW1lci9yZXN1bHQiLCJyZXEiOiI3NjFlZmQ1Mi05N2QwLTQ1MWYtOWNmOS1jZjg2NzQwZTdjYTMiLCJzeXMiOiI4MDE0ODYyMS04MjZmLTQ5YmUtOGM5ZS0zMTE1ZTUzMDFlMWIiLCJuYmYiOjE3MTIwMjkxNDIsImV4cCI6MTcxNDYyMTE0MiwiaWF0IjoxNzEyMDI5MTQyfQ.-FWTK4IJsu8AonfJTTq7_OA1qAh-9FU89iC1JZcRg_cToken original data sample
{ "sys":"test-system", "req":"761efd52-97d0-451f-9cf9-cf86740e7ca3", "uid":"gildong.hong", "rtn":"https://test.com/mfa/response","email":"gildong.hong@samsung.com","mobile":"+82-1012345678", "nbf": 1698232068, "exp": 1698239268, "iat": 1698232068, "displayUid": "gildong.hong@samsung.com" }
MFA Consumer Home RedirectregisterFlagYqueryBooleantrueDetermines whether to move to MFA Consumer Home. If true, it moves to MFA Consumer Home.
Table. Request Parameters

Response

  • registerFlag = true: Redirects to MFA Consumer Home.
  • registerFlag = false: Redirects to MFA authentication page.

Sample

RequestResponse
curl -X POST "https://stg2-cloud.singleid.samsung.net/test-tenant/common-api/open/v1.1/mfa/request?jwtTokenRequest=eyJhbGciOiJIUzI1NiJ9.eyJzeXMiOiJ0ZXN0LXN5c3RlbSIsInJlcSI6Ijc2MWVmZDUyLTk3ZDAtNDUxZi05Y2Y5LWNmODY3NDBlN2NhMyIsInVpZCI6Imppbm9uZS5raW0iLCJydG4iOiJodHRwczovL3Rlc3QuY29tL21mYS9yZXNwb25zZSIsIm5iZiI6MTY5ODIzMjA2OCwiZXhwIjoxNjk4MjM5MjY4LCJpYXQiOjE2OTgyMzIwNjh9.cDgKMHIINaHhBiyAd_OIlVvQwmUs0QaXH_RfJ8B_KdY&registerFlag=true"Page move
Table. Sample

Error Code

Http Response CodeError CodeError MessageAction Plan
400N/AN/ACheck token data.
Table. Error Code

API Specification - Send Email about Anomaly Detection(Tenant Admin Portal)

ModuleAPIURIMethodDescription
Tenant Admin PortalSend Email about Anomaly Detectionhttps://{domain}/{tenant-name}/admin-api/open/v1.1/emails/anomalyDetectionPOSTSends an email when a user is detected for abnormal authentication behavior.
Table. Send Email about Anomaly Detection(Tenant Admin Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
User IPaccessIPYBodyString10.0.0.0
Detection TimedetectionTimeYBodyString2023-09-10 23:01:01
EmailemailYBodyStringgildong.hong@samsung.com
User EnvironmentenvironmentYBodyStringPC / Window / Chrome
LanguagelanguageYBodyStringko
Network EnvironmentlocationYBodyStringInternal
Detection Rule NumberruleYBodyStringP001
User AccountusernameYBodyStringgildong.hong
Authentication GUIDenvGuidYBodyStringd8b09752-405a-4d52-8605-bff9aa3f4741
Table. Request Parameters

Response Parameter

PropertiesData TypeSample DataNote
결과booleantrueEmail sent successfully when true / failed when false
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg1-cloud.singleid.samsung.net:443/test-tenant/admin-api/open/v1.1/emails/anomalyDetection" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"accessIP\":\"10.0.0.0\",\"detectionTime\":\"2023-09-10 23:01:01\",\"email\":\"gildong.hong@samsung.com\",\"environment\":\"PC / Window / Chrome\",\"language\":\"ko\",\"location\":\"Internal\",\"rule\":\"P001\",\"username\":\"gildong.hong\",\"envGuid\":\"d8b09752-405a-4d52-8605-bff9aa3f4741\"}"true
Table. Sample

Error code

Http Response CodeError CodeError MessageMeasures
400N/AN/ABad Request
403N/AN/AForbidden
500N/AN/AInternal Server Error
Table. Error Code

API Specification - Send Email about New Sign-in Environment(Tenant Admin Portal)

ModuleAPIURIMethodDescription
Tenant Admin PortalSend Email about New Sign-in Environmenthttps://{domain}/{tenant-name}/admin-api/open/v1.1/emails/newSignInEnvironmentPOSTSends a notification email to the user when they sign in from a new environment and checks if the environment is registered.
Table. Send Email about New Sign-in Environment (Tenant Admin Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
User IPaccessIPYBodyString10.0.0.0
Registration TimedetectionTimeYBodyString2023-09-10 23:01:01
EmailemailYBodyStringgildong.hong@samsung.com
User EnvironmentenvironmentYBodyStringPC / Window / Chrome
LanguagelanguageYBodyStringko
Network Environment (Internal/External)locationYBodyStringInternal
Detection Rule NumberruleYBodyStringP001
User AccountusernameYBodyStringgildong.hong
Authentication Unique ValueenvGuidYBodyStringd8b09752-405a-4d52-8605-bff9aa3f4741
Table. Request Parameters

Response Parameter

PropertiesData TypeSample DataNote
Resultbooleantruetrue if the email is sent successfully, false otherwise
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg1-cloud.singleid.samsung.net:443/test-tenant/admin-api/open/v1.1/emails/anomalyDetection" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"accessIP\":\"10.0.0.0\",\"detectionTime\":\"2023-09-10 23:01:01\",\"email\":\"gildong.hong@samsung.com\",\"environment\":\"PC / Window / Chrome\",\"language\":\"ko\",\"location\":\"Internal\",\"rule\":\"P001\",\"username\":\"gildong.hong\",\"envGuid\":\"d8b09752-405a-4d52-8605-bff9aa3f4741\"}"true
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
400N/AN/ABad Request
403N/AN/AForbidden
500N/AN/AInternal Server Error
Table. Error Code

API Specification - Get User(User Portal)

ModuleAPIURIMethodDescription
User PortalGet Userhttps://{domain}/{tenant-name}/user-api/open/v1.1/users/{username}GETRetrieves the user’s name, email, preferred language, and timezone data.
Table. Get User(User Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
User IDusernameYPathStringgildong.hong
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
User IDusernameStringgildong.hong
EmailemailStringgildong.hong@stage.samsung.com
Full NameformattedNameString김동호
First NamegivenNameString동호
Last NamefamilyNameString김
English Full NameenFormattedNameStringDongho Kim
English First NameenGivenNameStringDongho
English Last NameenFamilyNameStringKim
Preferred LanguagepreferredLanguageStringko1) en : English 2) ko : Korean
Time ZonetimeZoneStringAsia/Seoul
Table. Response Parameters

Sample

RequestResponse
curl -X GET "https://stg2-cloud.singleid.samsung.net/test-tenant/user-api/open/v1.1/users/gildong.hong" -H "accept: application/json" -H "Authorization: Bearer {JWT_TOKEN}"{ "username": "gildong.hong", "email": "gildong.hong@stage.samsung.com", "formattedName": "김동호", "givenName": "동호", "familyName": "김", "enFormattedName": "Dongho Kim", "enGivenName": "Dongho", "enFamilyName": "Kim", "preferredLanguage": "ko", "timeZone": "Asia/Seoul" }
Table. Sample

Error Code

Http Response CodeError CodeError MessageCountermeasure
401N/AN/AIt is necessary to check if the JWT Token is valid.
Table. Error Code

API Specification - Get User Profile Image(User Portal)

ModuleAPIURIMethodDescription
User PortalGet User Profile Imagehttps://{domain}/{tenant-name}/user-api/open/v1.1/users/image/{username}GETRetrieves the user’s profile image data.
Table. Get User Profile Image(User Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
User IDusernameYPathStringgildong.hong
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
usernameusernameStringnull
Table. Response Parameters

Sample

RequestResponse
curl -X GET "https://stg2-cloud.singleid.samsung.net:443/test-tenant/user-api/open/v1.1/users/image/gildong.hong" -H "accept: application/json" -H "Authorization: Bearer {JWT_TOKEN}"File data { "username": null, "image": "![default-profile.png](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAM1BMVEUyMjIxMTEyMjIrKysyMjIwMDANDQ1HcEAAAABJRU5ErkJggg==)" } File URL { "username": "gildong.hong", "image": "![image](https://stgbox.singleid.samsung.net/files/img/google.png)" }
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
401N/AN/ACheck if the JWT Token is valid.
Table. Error Code

API Specification - Create account assignment list(User Portal)

ModuleAPIURIMethodDescription
User PortalCreate account assignment listhttps://{domain}/{tenant-name}/user-api/1.0/scp-auth/createPOSTCreates SCP permissions for the user.
Table. Create account assignment list (User Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
instance idinstanceIdYJSONStringProvided by SCP
permission set idpermissionSetIdYJSONString“PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf”Provided by SCP
principal idprincipalIdYJSONString“gildong.hong”User’s username
principal typeprincipalTypeYJSONString“USER”Currently only USER is available
target idtargetIdYJSONString“PROJECT-ka2tfhLHsweVwm4BrR1rae”PROJECT ID, provided by SCP
target typetargetTypeYJSONString“PROJECT”Currently only PROJECT is available
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
instance idinstanceIdJSONReturned saved value
permission set idpermissionSetIdJSON“PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf”Returned saved value
principal idprincipalIdJSON“gildong.hong”Returned saved value
principal typeprincipalTypeJSON“USER”Returned saved value
target idtargetIdJSON“PROJECT-ka2tfhLHsweVwm4BrR1rae”Returned saved value
target typetargetTypeJSON“PROJECT”Returned saved value
statusstatusJSON“SUCCESS”Success or failure
failure reasonfailureReasonJSONReason for failure
created datecreatedDateJSONcreation time
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg-scloud.singleid.samsung.net:443/stg4/user-api/1.0/scp-auth/create" -H "accept: application/json"-H "apiKey: {apiKey}" INPUT JSON{ "instanceId": "instnace-01", "permissionSetId": "PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf", "principalId": "singleid.test001", "principalType": "USER", "targetId": "PROJECT-ka2tfhLHsweVwm4BrR1rae", "targetType": "PROJECT" }{ "instanceId": "instnace-01", "permissionSetId": "PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf", "principalId": "singleid.test001", "principalType": "USER", "targetId": "PROJECT-ka2tfhLHsweVwm4BrR1rae", "targetType": "PROJECT" "status": "SUCCESS", "createdDate": "2024-04-03T01:58:46.538Z", "failureReason": "" }
Table. Sample

API Specification - Delete account assignment list(User Portal)

ModuleAPIURIMethodDescription
User PortalDelete account assignment listhttps://{domain}/{tenant-name}/user-api/1.0/scp-auth/create](https://{domain}/{tenant-name}/user-api/1.0/scp-auth/deletePOSTDeletes the SCP authority for the user.
Table. Delete account assignment list(User Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
instance idinstanceIdYJSONStringProvided by SCP
permission set idpermissionSetIdYJSONString“PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf”Provided by SCP
principal idprincipalIdYJSONString“gildong.hong”User’s username
principal typeprincipalTypeYJSONString“USER”Currently only USER is available
target idtargetIdYJSONString“PROJECT-ka2tfhLHsweVwm4BrR1rae”Project ID, provided by SCP
target typetargetTypeYJSONString“PROJECT”Currently only PROJECT is functional
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
instance idinstanceIdJSONDeleted value returned
permission set idpermissionSetIdJSON“PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf”Deleted value returned
principal idprincipalIdJSON“gildong.hong”Deleted value returned
principal typeprincipalTypeJSON“USER”Deleted value returned
target idtargetIdJSON“PROJECT-ka2tfhLHsweVwm4BrR1rae”Deleted value returned
target typetargetTypeJSON“PROJECT”Deleted value returned
statusstatusJSON“SUCCESS”Success or failure
failure reasonfailureReasonJSONFailure reason
created datecreatedDateJSONDeletion date
Table. Response Parameters

Sample

RequestResponse
curl -X GET "https://stg1-cloud.singleid.samsung.net/test-tenant/common-api/open/v1.1/asis/test-tenant/user/mfa/token/authentication?userName=mkdir.kim&protocol=uma-uaf&sessionDataKey=sessionDataKey111&redirectUrl=redirectUrl1111&errorRedirectUrl=errorRedirectUrl1111&params=params111&language=en"{ "result": "SUCCESS", "value": { "token": "eyJpc3MiOiJodHRwczovL3N0ZzItY2xvdWQuaWFtLnNhbXN1bmcubmV0Iiwic3ViIjoibWtkaXIua2ltIiwiYXVkIjoiaHR0cHM6Ly9zdGcyLWNsb3VkLmlhbS5zYW1zdW5nLm5ldCIsImV4cCI6MTY5ODEyOTM2OSwiaWF0IjoxNjk4MTI5MTg5LCJqdGkiOiJkNWZmZGE5Ny1mMzZkLTRjZDktYWJmZi1mMzY4ZTkxYWVkNTUiLCJhbXIiOltdLCJ6b25laW5mbyI6IkFzaWEvU2VvdWwiLCJsb2NhbGUiOiJlbl9VUyIsInByb3RvY29sIjoidW1hLXVhZiIsInJlZGlyZWN0X3VybCI6InJlZGlyZWN0VXJsMSIsImVycm9yX3JlZGlyZWN0X3VybCI6ImVycm9yUmVkaXJlY3RVcmwxIiwicGFyYW1zIjoicGFyYW1zMSIsInVzZXJJZCI6Im1rZGlyLmtpbSJ9:MEUCIHqWV_UcgKHsMlDI7Ks31fw1QPpCYnKorMpnr2L653LwAiEAz30ShMmACEi6H-IuF1YMV2bKT1WIFmAdJ6OCsmEzscA", "serviceUri": "/ua/MPHTOCHW5I/de6f67d0-8bec-46ac-bf53-16ef00eb2066/dgauth/mfa", "appId": null }, "message": "succeeded to get nexsign token.", "statusCode": null, "statusCodeValue": "0", "data": null}
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
400N/AN/AYou must check the userName.
Table. Error Code

API Specification - Get account assignment list(User Portal)

ModuleAPIURIMethodDescription
User PortalGet account assignment listhttps://{domain}/{tenant-name}/user-api/1.0/scp-auth/listPOSTRetrieves the SCP authority for the user.
Table. Get account assignment list(User Portal)

Request Parameter

No.PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
1principal typeprincipalTypeYqueryString“USER”Currently only USER is available
2principal idprincipalIdYqueryString“gildong.hong”The username of the user to be queried
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
instance idinstanceIdJSON
permission set idpermissionSetIdJSON“PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf”
principal idprincipalIdJSON“gildong.hong”
principal typeprincipalTypeJSON“USER”
target idtargetIdJSON“PROJECT-ka2tfhLHsweVwm4BrR1rae”
target typetargetTypeJSON“PROJECT”
Table. Response Parameters

Sample

RequestResponse
curl -X GET "https://stg-scloud.singleid.samsung.net:443/stg4/user-api/1.0/scp-auth/list?principalType=USER&principalId=singleid.test001" -H "accept: application/json" -H "apiKey: {apiKey}"[ { "instanceId": "instnace-01", "permissionSetId": "PERMISSION-SET-Ablxc5__qEaIYmWGyMeqlf", "principalId": "singleid.test001", "principalType": "USER", "targetId": "PROJECT-ka2tfhLHsweVwm4BrR1rae", "targetType": "PROJECT" }, { "instanceId": "instnace-01", "permissionSetId": "PERMISSION-SET-Ablxc5__qEaIYmWGyMe121", "principalId": "singleid.test001", "principalType": "USER", "targetId": "PROJECT-ka2tfhLHsweVwm4BrR1rae", "targetType": "PROJECT" } ]
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
401N/AN/AThe API key needs to be verified for validity.
Table. Error Code

API Specification - Search User(User Portal)

ModuleAPIURIMethodDescription
User PortalSearch Userhttps://{domain}/{tenant-name}/user-api/1.0/scp-user/listPOSTSearches for target users in SCP.
Table. Search User(User Portal)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
pagepageNqueryInteger0Page to retrieve
sizesizeNqueryInteger10Page size
usernameusernameNqueryString“gildong.hong”User ID to search
group namegroupNameNqueryString“ADGroup”Group to search
create Date(from)creationDateGeNqueryDateTime“2024-04-03T07:49:23.845Z”
create Date(to)creationDateLeNqueryDateTime“2024-04-03T07:49:23.845Z”
last change date(from)lastChangeDateGeNqueryDateTime“2024-04-03T07:49:23.845Z”
last change date(to)lastChangeDateLeNqueryDateTime“2024-04-03T07:49:23.845Z”
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
keykeyString“01890501-74fa-7785-91e0-67bd71217a2e”
usernameusernameString“gildong.hong”
administratoradministratorBooleanfalse
formatted nameformattedNameString“Gildong Hong”
formatted Name(en)enFormattedNameString“gildong hong”
emailemailString“gildong.hong@samsung.com”
mobilemobileString“+02-01011112222”
preferred languagepreferredLanguageString“en”
time zonetimeZoneString“Asia/Seoul”
managed bymanagedByString“SINGLEID”
creatorcreatorString“admin001”
creation datecreationDateDateTime“2024-04-03T07:49:23.845Z”
last modifierlastModifierString“admin001”
last change datelastChangeDateDateTime“2024-04-03T07:49:23.845Z”
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg-scloud.singleid.samsung.net:443/stg4/user-api/1.0/scp-user/list" -H "accept: application/json" -H "apiKey: {apiKey}"[ { "key": "01890501-74fa-7785-91e0-67bd71217a2e", "administrator": false, "username": "gildong.hong", "enFormattedName": "gildong hong", "formattedName": "Gildong Hong", "email": "gildong.hong@samsung.com", "mobile": "+02-01011112222", "preferredLanguage": "en", "timeZone": "Asia/Seoul", "managedBy": "SINGLEID", "creator": "admin001", "creationDate": "2024-04-03T07:49:23.845Z", "lastModifier": "admin001", "lastChangeDate": "2024-04-03T07:49:23.845Z" }, { "key": "01890501-74fa-7785-91e0-67bd71217a2e", "administrator": false, "username": "gildong.hong", "enFormattedName": "gildong hong", "formattedName": "Gildong Hong", "email": "gildong.hong@samsung.com", "mobile": "+02-01011112222", "preferredLanguage": "en", "timeZone": "Asia/Seoul", "managedBy": "SINGLEID", "creator": "admin001", "creationDate": "2024-04-03T07:49:23.845Z", "lastModifier": "admin001", "lastChangeDate": "2024-04-03T07:49:23.845Z" } ]
Table. Sample

Error Code

Http Response CodeError CodeError MessageMeasures
401N/AN/ACheck if the API key is valid.
Table. Error Code

API Specification - MFA Consumer Request(Portal Common)

ModuleAPIURIMethodDescription
Portal CommonMFA Consumer Requesthttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/request/mfaPOSTRequests MFA.
Table. MFA Consumer Request(Portal Common)

Request Parameter

No.PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
1usernameusernameYBodyStringmkdir.kim
2authentication typetypeNBodyStringemailemail, sms, msg, uaApp, uaMOTP, one of them. If not specified, it follows the default setting or user’s preferred method.
3serviceProviderIdserviceProviderIdYBodyStringd8b09752-405a-4d52-8605-bff9aa3f4741UUID. Device ID assigned after registration in SingleID Admin Portal.
Table. Request Parameters

Response Parameter

PropertiesAttributeData TypeSample DataNote
requestIdrequestIdString01890501-74fa-7785-91e0-67bd71217a2eUUID. Used as a request parameter for MFA verification.
authentication typetypeStringsmsemail, sms, msg, uaApp, uaMOTP, one of them. Verification logic may vary depending on the MFA type.
otpotpString1234566-digit or 8-digit number. Issued only when the type is uaMOTP (6-digit) or uaApp (8-digit).
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg1-cloud.singleid.samsung.net:443/test/common-api/open/v1.1/mfa/request/mfa" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"username\":\"mkdir.kim\",\"type\":\"sms\",\"serviceProviderId\":\"dceef541-1f22-479d-96ac-c402ab0789e9\"}{ "otp": "123456", "requestId": "d8b09752-405a-4d52-8605-bff9aa3f4741", "serviceProviderId": "", "type": "sms", "username": "" }
Table. Sample

Error Codes and Responses

Http Response CodeError CodeError MessageAction Plan
400N/Acommon.error.requiredValueThe required value is missing. Please check.
400N/Auser.error.notFoundThe user was not found. Please check the user ID
400N/AserviceProvider.error.notFoundThe service provider was not found. Please contact the administrator
400N/Aauthenticator.error.notFoundThe authentication method was not found. Please contact the administrator
400N/Acommon.error.disallowedValueThe type is incorrect. Please contact the administrator
400N/Auser.error.locked + remainThe account is locked. Please try again after {remain} minutes.
400N/Aotp.error.tooManyAttemptsMove to the security warning screen (the account is locked due to multiple authentication failures)
Table. Error Code

API Specification - MFA Consumer Verification(Portal Common)

ModuleAPIURIMethodDescription
Portal CommonMFA Consumer Verificationhttps://{domain}/{tenant-name}/common-api/open/v1.1/mfa/verification/mfaPOSTVerifies the MFA.
Table. MFA Consumer Verification(Portal Common)

Request Parameter

PropertiesAttributeMandatoryParameter TypeData TypeSample DataNote
requestIdrequestIdYBodyStringd8b09752-405a-4d52-8605-bff9aa3f4741UUID
otpotpNBodyString1234566-digit number/Not required for uaApp, uaMOTP
Table. Request Parameters

Response Parameter

Http Status CodeStatus
200Authentication completed
202Authentication pending (only occurs when type is uaMOTP, uaApp. Periodic polling is required until the result is confirmed with a 200 status code)
OthersError
Table. Response Parameters

Sample

RequestResponse
curl -X POST "https://stg1-cloud.singleid.samsung.net:443/test/common-api/open/v1.1/mfa/verification/mfa" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"otp\":\"000000\",\"requestId\":\"095db652-877f-42e5-b87f-e404fb07048b\"}"{ “statusCode”: “ACCEPTED”, }
Table. Sample

Error Codes

Http Response CodeError CodeError MessageMeasures to Take
400N/Acommon.error.requiredValueThe required value is missing. Please check.
400N/Acommon.error.invalidRequestThe request is not found. Please contact the administrator.
400N/Arequest.error.invalidStatusThe request status is incorrect. Please contact the administrator.
400N/Aotp.error.notMatchThe OTP is incorrect. Please check the OTP.
400N/Aotp.error.tooManyAttemptsMove to the security warning screen (the account is locked due to multiple authentication failures)
Table. Error Code
Open Source Licence(ISO)
ADFS Adapter Guide