Updates a Subscriber

Request

Modifies existing Subscriber.
Only modified attributes may be passed in payload. All other attributes will remain unchanged.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

subscriber_idintegerrequired

id of the subscriber

Query

api_versionstring

Api version

Value:"V3-R1"

Bodyapplication/json

idp_idstring or null

Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.

Example:"internal-identifier-at-company.com"

curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/subscribers/{subscriber_id}?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "idp_id": "internal-identifier-at-company.com"
  }'

Responses

OK

Bodyapplication/json

idinteger, >= 1

Example:67

idp_idstring or null

Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.

Example:"internal-identifier-at-company.com"

flagsobject

created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

Response

{
  "id": 67,
  "idp_id": "internal-identifier-at-company.com",
  "flags": {
    "deleted": false
  },
  "created_at": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z"
}