Skip to main content

Updates a directory-managed user group configured in the platform

PUT 
/references/users/groups/:groupID

'Updates an existing directory-managed user group'

Request​

Path Parameters

    groupID uuidrequired

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

Request object to update an existing directory-managed user group

    Name stringrequired

    Possible values: <= 64 characters

    Display name for the user group

    Status StatusEnum (string)required

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

A user group

Response Headers

  • x-fapi-interaction-id

    string

Schema

    Name stringrequired

    Possible values: <= 64 characters

    Display name for the user group

    Status StatusEnum (string)required

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    ID uuid

    Unique identifier of the given User Group

    ManagementType UserGroupManagementType (string)

    Possible values: [directory, raidiam]

    Indicator as to which platform can manage the user group

    CreatedAt date-time
    UpdatedAt date-time
Loading...