Administration

Update Credential Distribution Group by ID

Update an existing Credential Distribution Group by the specified ID.

put/credential-distribution-groups/{id}

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/credential-distribution-groups/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The Credential Distribution Group ID.

Request body

namestring required

Name of the credential distribution group.

enable_email_approvalboolean required

Flag indicating whether email approval is enabled (true) or disabled (false).

enable_user_limitationboolean required

Flag indicating whether user limitation is enabled (true) or disabled (false).

employee_group_type'ADMIN' | 'AD' | 'MANAGE' required
restrict_numberinteger

Number restriction.

user_group_idsinteger[]

Array of user group IDs.

Response

OK

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

org_idinteger

The organization identifier, valid when enabling HIQ feature

owner_idinteger

The owner ID of the Credential Distribution group

group_typestring

The Group type

enable_email_approvalboolean

Whether email approval is enabled

enable_user_limitationboolean

Whether user limitation is enabled

employee_group_type'ADMIN' | 'AD' | 'MANAGE'
namestring

The name of the credential distribution group

restrict_numberstring

Restriction on number of credentials per employee

Changes

No operation changes recorded.