REST Resource: projects.locations.authorizationPolicies

Recurso: AuthorizationPolicy

AuthorizationPolicy es un recurso que especifica cómo un servidor debe autorizar las conexiones entrantes. Este recurso no cambia la configuración, a menos que esté conectado a un proxy HTTPS de destino o a un recurso selector de configuración de extremo.

Representación JSON
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "action": enum (Action),
  "rules": [
    {
      object (Rule)
    }
  ]
}
Campos
name

string

Obligatorio. Es el nombre del recurso AuthorizationPolicy. Coincide con el patrón projects/{project}/locations/{location}/authorizationPolicies/<authorizationPolicy>.

description

string

Es opcional. Es la descripción de texto libre del recurso.

createTime

string (Timestamp format)

Solo salida. Marca de tiempo cuando se creó el recurso.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo salida. La marca de tiempo cuando se creó el recurso.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Es opcional. Es un conjunto de etiquetas asociadas con el recurso AuthorizationPolicy.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

action

enum (Action)

Obligatorio. Es la acción que se debe realizar cuando se encuentra una coincidencia de regla. Los valores posibles son "ALLOW" o "DENY".

rules[]

object (Rule)

Es opcional. Es la lista de reglas que deben coincidir. Ten en cuenta que al menos una de las reglas debe coincidir para que se realice la acción especificada en el campo "action". Una regla es una coincidencia si hay un origen y un destino que coinciden. Si se deja en blanco, la acción especificada en el campo action se aplicará a cada solicitud.

Acción

Son los valores posibles que definen qué acción realizar.

Enums
ACTION_UNSPECIFIED Valor predeterminado.
ALLOW Otorga acceso.
DENY Deniega el acceso. Se deben evitar las reglas de denegación, a menos que se usen para proporcionar un resguardo predeterminado de "denegar todo".

Regla

Especificación de reglas.

Representación JSON
{
  "sources": [
    {
      object (Source)
    }
  ],
  "destinations": [
    {
      object (Destination)
    }
  ]
}
Campos
sources[]

object (Source)

Es opcional. Es la lista de atributos de la fuente de tráfico. Todas las fuentes deben coincidir. Una fuente es una coincidencia si coinciden tanto los principales como los ipBlocks. Si no se establece, la acción especificada en el campo "action" se aplicará sin ninguna verificación de reglas para la fuente.

destinations[]

object (Destination)

Es opcional. Es la lista de atributos para el destino del tráfico. Todos los destinos deben coincidir. Un destino es una coincidencia si una solicitud coincide con todos los hosts, puertos, métodos y encabezados especificados. Si no se establece, la acción especificada en el campo "action" se aplicará sin ninguna verificación de reglas para el destino.

Fuente

Especificación de los atributos de la fuente de tráfico.

Representación JSON
{
  "principals": [
    string
  ],
  "ipBlocks": [
    string
  ]
}
Campos
principals[]

string

Es opcional. Es la lista de identidades de pares que deben coincidir para la autorización. Al menos una principal debe coincidir. Cada par puede ser una coincidencia exacta, una coincidencia de prefijo (por ejemplo, "namespace/*"), una coincidencia de sufijo (por ejemplo, "*/service-account") o una coincidencia de presencia "*". La autorización basada en el nombre de la principal sin validación de certificado (configurada por el recurso ServerTlsPolicy) se considera insegura.

ipBlocks[]

string

Es opcional. Es una lista de rangos CIDR que se deben hacer coincidir según la dirección IP de origen. Al menos un bloque de IP debe coincidir. Se admiten IP única (p.ej., "1.2.3.4") y CIDR (p.ej., "1.2.3.0/24"). Se debe evitar la autorización basada solo en la IP de origen. Las direcciones IP de cualquier balanceador de cargas o proxy deben considerarse no confiables.

Destino

Especificación de los atributos de destino del tráfico.

Representación JSON
{
  "hosts": [
    string
  ],
  "ports": [
    integer
  ],
  "paths": [
    string
  ],
  "methods": [
    string
  ],
  "httpHeaderMatch": {
    object (HttpHeaderMatch)
  }
}
Campos
hosts[]

string

Obligatorio. Es la lista de nombres de host que deben coincidir. Se compara con el encabezado ":authority" en las solicitudes HTTP. Al menos un host debe coincidir. Cada host puede ser una coincidencia exacta, una coincidencia de prefijo (por ejemplo, "mydomain.*"), una coincidencia de sufijo (por ejemplo, "*.myorg.com") o una coincidencia de presencia (cualquiera) "*".

ports[]

integer (uint32 format)

Obligatorio. Es la lista de puertos de destino que deben coincidir. Al menos un puerto debe coincidir.

paths[]

string

Es opcional. Es una lista de rutas de acceso HTTP que deben coincidir. Los métodos de gRPC deben presentarse como un nombre completamente calificado con el formato "/packageName.serviceName/methodName". Al menos una ruta de acceso debe coincidir. Cada ruta puede ser una coincidencia exacta, una coincidencia de prefijo (por ejemplo, "/packageName.serviceName/*"), una coincidencia de sufijo (por ejemplo, "*/video") o una coincidencia de presencia (cualquiera) "*".

methods[]

string

Es opcional. Es una lista de métodos HTTP con los que se establece la coincidencia. Al menos un método debe coincidir. No se debe configurar para los servicios de gRPC.

httpHeaderMatch

object (HttpHeaderMatch)

Es opcional. Coincide con el par clave:valor en el encabezado HTTP. Proporciona una coincidencia flexible basada en encabezados HTTP para casos de uso potencialmente avanzados. Debe coincidir al menos un encabezado. Evita usar coincidencias de encabezados para tomar decisiones de autorización, a menos que haya una garantía sólida de que las solicitudes llegan a través de un cliente o proxy de confianza.

HttpHeaderMatch

Especificación de los atributos de coincidencia del encabezado HTTP.

Representación JSON
{
  "headerName": string,

  // Union field type can be only one of the following:
  "regexMatch": string
  // End of list of possible types for union field type.
}
Campos
headerName

string

Obligatorio. Es el nombre del encabezado HTTP que se debe hacer coincidir. Para que coincida con la autoridad de la solicitud HTTP, usa un headerMatch con el nombre de encabezado ":authority". Para que coincida con el método de una solicitud, usa el headerName ":method".

Campo de unión type.

type puede ser una de las siguientes opciones:

regexMatch

string

Obligatorio. El valor del encabezado debe coincidir con la expresión regular especificada en regexMatch. Para conocer la gramática de las expresiones regulares, consulta: en.cppreference.com/w/cpp/regex/ecmascript Para que coincida con un puerto especificado en la solicitud HTTP, usa un headerMatch con headerName establecido en Host y una expresión regular que satisfaga el especificador de puerto del encabezado Host de RFC2616.

Métodos

create

Crea una nueva AuthorizationPolicy en un proyecto y una ubicación determinados.

delete

Borra una sola AuthorizationPolicy.

get

Obtiene los detalles de una sola AuthorizationPolicy.

list

Enumera AuthorizationPolicies en una ubicación y un proyecto determinados.

patch

Actualiza los parámetros de una sola AuthorizationPolicy.