PATCH api/v1/admin/scim/{id}

Updates the SCIM status on the account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the account.

globally unique identifier

Required

Body Parameters

The SCIM status.

TwoSms.CustomerPortalRole.API.Admin.SSO.SCIMRequest
NameDescriptionTypeAdditional information
Status

Enable/Disable SCIM on the account.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Status": true
}

application/xml, text/xml

Sample:
<SCIMRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>true</Status>
</SCIMRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.SSO.SCIMResponse
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.SSO.SCIMResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "Status": true,
      "Token": "sample string 2",
      "URL": "sample string 3"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfSCIMResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Status>true</Status>
      <Token>sample string 2</Token>
      <URL>sample string 3</URL>
    </Detail>
  </ResponseData>
</ResponseOfSCIMResponse>