REST Resource: matters

Recurso: Matter

Representa un asunto.

Para trabajar con los recursos de Vault, la cuenta debe tener los privilegios de Vault necesarios y acceso al asunto. Para acceder a un asunto, la cuenta debe haberlo creado, compartirlo con ella o tener el privilegio Ver todos los asuntos.

Representación JSON
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ],
  "matterRegion": enum (MatterRegion)
}
Campos
matterId

string

El ID de asunto, que genera el servidor. Déjalo en blanco cuando crees un asunto.

name

string

Es el nombre del asunto.

description

string

Una descripción opcional del asunto.

state

enum (State)

Es el estado del asunto.

matterPermissions[]

object (MatterPermission)

Muestra una lista de los usuarios y sus permisos para el asunto. Actualmente, no hay un límite definido por el programador para la cantidad de permisos que puede tener un asunto.

matterRegion

enum (MatterRegion)

Opcional. La región de datos solicitada para el asunto

Estado

Es el estado de un asunto.

Enumeraciones
STATE_UNSPECIFIED El asunto no tiene un estado especificado.
OPEN El asunto está abierto.
CLOSED El asunto está cerrado.
DELETED Se borrará el asunto.

MatterPermission

Los usuarios pueden ser propietarios o colaboradores de la materia. Cada asunto tiene un solo propietario. Todos los demás usuarios que pueden acceder al asunto son colaboradores. Cuando se borra una cuenta, sus recursos de MatterPermission correspondientes dejan de existir.

Representación JSON
{
  "role": enum (AclRole),
  "accountId": string
}
Campos
role

enum (AclRole)

El rol del usuario en el asunto

accountId

string

El ID de la cuenta, como lo proporciona el SDK de Admin

AclRole

Los posibles permisos del usuario para una materia, en orden de aumento de permisos.

Enumeraciones
ROLE_UNSPECIFIED No se asignaron funciones.
COLLABORATOR Un colaborador sobre el asunto.
OWNER Es el propietario del asunto.

MatterRegion

La región de datos del asunto

Enumeraciones
MATTER_REGION_UNSPECIFIED La región no se especifica. El valor predeterminado es ANY.
ANY Cualquier región
US Región de Estados Unidos.
EUROPE Región de Europa.

Métodos

addPermissions

Agrega una cuenta como colaborador de un asunto.

close

Cierra el asunto especificado.

count

Cuenta las cuentas que procesa la consulta especificada.

create

Crea un asunto con el nombre y la descripción que se indican.

delete

Borra el asunto especificado.

get

Obtiene el asunto especificado.

list

Muestra una lista de los asuntos a los que tiene acceso el solicitante.

removePermissions

Quita una cuenta como colaborador de un asunto.

reopen

Vuelve a abrir el asunto especificado.

undelete

Devuelve a la carpeta de elementos borrados el asunto especificado.

update

Actualiza el asunto especificado.