Skip to main content

Toggle active status of users data administrator role

PUT 
/users/data-administrator/:UserEmailOrID

Deactivate or reactivate a users data administrator role

Request​

Path Parameters

    UserEmailOrID UserEmailOrIDrequired

    Possible values: <= 50 characters, Value must match regular expression ^[^<>]*$

    UUID or email address of the user. Note use of the email address is considered deprecated

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Body

required

Properties to toggle a user between activated and deactivated status

    Status StatusEnum (string)required

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

A users with the data administrator role

Response Headers

  • x-fapi-interaction-id

    string

Schema

    UserID uuid

    Possible values: <= 40 characters

    The unique ID of a user

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    Email string

    Possible values: Value must match regular expression ^[^<>]*$

    Users email address

Loading...