client.permission_sets.put_archive

A method of the Permission Sets endpoint.

put_archive(id: int, status: bool) Response

Update the archive status of this object

API URL: PUT /permission_sets/{id}/archive

import civis
client = civis.APIClient()
response = client.permission_sets.put_archive(...)
Parameters:
idint

The ID of the object.

statusbool

The desired archived status of the object.

Returns:
civis.Response
  • idint

    The ID for this permission set.

  • namestr

    The name of this permission set.

  • descriptionstr

    A description of this permission set.

  • authorcivis.Response
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.

  • created_at : str (time)

  • updated_at : str (time)

  • archivedbool

    The archival status of the requested item(s).