Crea y administra espacios de Apigee

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En esta página, se describe cómo crear espacios de Apigee en tu organización de Apigee para administrar las políticas de Identity and Access Management (IAM) para los recursos de la API de Apigee a gran escala.

En esta guía, se describen los pasos necesarios para hacer lo siguiente:

• Crear un espacio
• Administrar miembros y roles en un espacio
• Enumerar todos los espacios de una organización
• Obtener detalles del espacio
• Actualizar un espacio
• Borrar un espacio

Para obtener más información sobre los beneficios de usar Apigee Spaces para administrar tus recursos de API, consulta Apigee Spaces.

Antes de comenzar

Antes de comenzar a usar Spaces, ten en cuenta lo siguiente:

• Aprovisiona Apigee. Confirma que se aprovisione la organización de suscripción o pago por uso de Apigee que deseas usar. Para obtener más información acerca de los pasos necesarios para aprovisionar Apigee, consulta Introducción al aprovisionamiento.
• Obtén tus credenciales de autenticación. Antes de ejecutar comandos para crear y administrar Spaces en la línea de comandos, obtén tus credenciales de autenticación gcloud con el siguiente comando:

  export TOKEN=$(gcloud auth print-access-token)

Roles y permisos requeridos

Asegúrate de tener los siguientes roles en el proyecto: Apigee > Apigee Organization Admin

Verifica los roles

1. En la Google Cloud consola de, dirígete a la página IAM.

   Ir a IAM
2. Selecciona el proyecto.

3. En la columna Principal, busca todas las filas que te identifiquen a ti o a un grupo en el que se te incluya. Para saber en qué grupos estás incluido, comunícate con tu administrador.

4. Para todas las filas en las que se te especifique o se te incluya, verifica la columna Rol para ver si la lista de roles incluye los roles necesarios.

Otorga los roles

1. En la Google Cloud consola de, dirígete a la página IAM.

   Ir a IAM
2. Selecciona el proyecto.
3. Haz clic en Otorgar acceso.

4. En el campo Principales nuevas, ingresa tu identificador de usuario. Esta suele ser la dirección de correo electrónico de una Cuenta de Google.

5. Haz clic en Seleccionar un rol y, luego, busca el rol.
6. Para otorgar roles adicionales, haz clic en Agregar otro rol y agrega uno más.
7. Haz clic en Guardar.

Crear un espacio

Para realizar esta tarea, necesitas el permiso apigee.spaces.create. Este permiso se incluye en la función Apigee Organization Admin.

Crea un espacio en tu organización de Apigee con la consola de Apigee o la API, como se describe en las siguientes secciones.

Consola de Apigee

Para crear un espacio con la IU de Apigee, haz lo siguiente:

1. En la IU de Apigee en la consola de Cloud, ve a la página Spaces.
   Ir a Spaces
2. Haz clic en Crear. Se abrirá el panel Agregar detalles del espacio.
3. En el campo Nombre, ingresa un identificador único para el espacio. El nombre debe tener menos de 63 caracteres, comenzar con una letra minúscula y contener solo caracteres en minúscula. Para conocer los requisitos de nombres completos, consulta AIP-122: Nombres de recursos.
4. (Opcional) En el campo Nombre visible, ingresa una etiqueta legible por humanos para el espacio.
5. Haz clic en Agregar.

Después de la creación, los miembros de la organización verán el espacio como un parámetro disponible cuando creen recursos de API.

API de Apigee

Para crear un espacio en tu organización de Apigee, usa el siguiente comando:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces" \
    --data-raw '{
       "name":"SPACE_NAME",
       "displayName":"DISPLAY_NAME"
    }'

Aquí:

• ORG_NAME es el nombre de tu organización de Apigee.
• SPACE_NAME es el nombre y el identificador único del espacio. El nombre debe tener menos de 63 caracteres, comenzar con una letra minúscula y contener solo caracteres en minúscula. Para conocer los requisitos de nombres completos, consulta AIP-122: Nombres de recursos.
• DISPLAY_NAME es el nombre legible por humanos del espacio tal como aparece en la IU de Apigee en la consola de Cloud.

Administrar miembros y roles en un espacio

Después de crear un espacio, puedes agregar miembros del equipo al espacio y asignar los roles de IAM necesarios para crear y administrar los recursos de API.

Agrega un miembro de la organización a un espacio

Para realizar esta tarea, necesitas el permiso apigee.spaces.setIamPolicy.

Nota: El rol de IAM apigee.spaceContentEditor contiene muchos de los permisos necesarios para administrar los recursos del espacio. Te recomendamos que otorgues este rol, como mínimo, a los usuarios del espacio. Sin embargo, es posible que debas otorgar roles adicionales a los usuarios para que realicen tareas específicas. Para obtener más información, consulta Jerarquía de permisos de IAM en Spaces.

Consola de Apigee

Para otorgar acceso a un miembro a un espacio con la IU de Apigee, haz lo siguiente:

1. En la IU de Apigee en la consola de Cloud, ve a la página Spaces.
2. Haz clic en el nombre del espacio que deseas administrar.
3. En la sección Detalles de acceso, haz clic en Otorgar acceso.
4. En el campo Agregar miembros, ingresa las direcciones de correo electrónico de los usuarios o grupos que deseas agregar.
5. En Asignar rol, selecciona Editor de contenido o Visualizador de contenido.
6. Haz clic en Agregar.

Nota: Si tienes el resourcemanager.projects.setIamPolicy permiso, el sistema otorga automáticamente a cada miembro nuevo el rol de Usuario de la consola de Apigee Space a nivel del proyecto, lo que le permite acceder a la IU de Apigee en la consola de Cloud. Si no tienes este permiso, verás una advertencia y un administrador del proyecto debe otorgar este rol a los usuarios de forma manual.

API de Apigee

Para agregar un miembro de la organización a un Space y asignarle un rol de IAM, usa el siguiente comando:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME:setIamPolicy" -d \
      '{
        "policy":{
          "bindings":[
            {
              "members": ["user:USER_EMAIL"],
              "role": "roles/IAM_ROLE"
            }
          ]
        }
      }'

Aquí:

• ORG_NAME es el nombre de tu organización de Apigee.
• SPACE_NAME es el nombre del espacio.
• USER_EMAIL es la dirección de correo electrónico del usuario que estás agregando al espacio. Para agregar un Grupo de Google en lugar de un solo usuario, cambia el prefijo de user: a group: y proporciona la dirección de correo electrónico del grupo.
• IAM_ROLE es el nombre del rol de IAM que le asignas al miembro.

Quita miembros de un Space

Para realizar esta tarea, necesitas el permiso apigee.spaces.setIamPolicy.

Consola de Apigee

Para quitar un miembro de un espacio con la IU de Apigee, haz lo siguiente:

1. En la IU de Apigee en la consola de Cloud, ve a la página Spaces y haz clic en el nombre del espacio.
2. En la tabla Detalles de acceso, selecciona la casilla de verificación junto a uno o más miembros que deseas quitar.
3. Haz clic en Quitar acceso.
4. En el cuadro de diálogo Confirmación, haz clic en Confirmar.

API de Apigee

Para quitar miembros de un espacio, configura una nueva política de IAM para el espacio con la lista revisada de miembros mediante el método setIamPolicy. Si usas este método se crea una nueva política de IAM que reemplaza la política existente.

Por ejemplo, para actualizar a los miembros del Space del equipo azul, primero puedes verificar la política de IAM actual con el siguiente comando:

curl -X GET -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/acme/spaces/blue:getIamPolicy"

El resultado del comando muestra la política de IAM actual del Space y debería verse de la siguiente manera:

{
  "version": "0",
  "bindings": [
    {
      "role": "roles/apigee.spaceContentEditor",
      "members": [
        "group:[e-mail]",
        "user:[e-mail]",
        "user:[e-mail]",
        "user:[e-mail]"
      ]
    }
  ]
}

Para quitar [e-mail] del Space, usa el siguiente comando:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-type: application/json" \
  "https://apigee.googleapis.com/v1/organizations/acme/spaces/blue:setIamPolicy" -d \
    '{
      "policy":{
        "bindings":[
          {
            "members": [
              "group:[e-mail]",
              "user:[e-mail]",
              "user:[e-mail]"
            ],
            "role": "roles/apigee.spaceContentEditor"
          }
        ]
      }
    }'

La nueva política de IAM del Space ya no incluirá [e-mail].

Para quitar a un miembro de un grupo incluido en un Space, primero quítalo del grupo y, luego, vuelve a ejecutar el comando setIamPolicy para actualizar la política de IAM del Space con la membresía correcta para el alias de correo electrónico del grupo.

Enumera todos los espacios de una organización

Para realizar esta tarea, necesitas el permiso apigee.spaces.list.

Consola de Apigee

Para ver todos los espacios, ve a la página Spaces en la IU de Apigee en la consola de Cloud.

Ir a Spaces

En la tabla Spaces, se enumeran todos los espacios de tu organización, incluidos su Nombre, Nombre visible y la cantidad total de Miembros.

API de Apigee

Para enumerar todos los espacios en una organización de Apigee, usa el siguiente comando:

curl -X GET -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces"

Aquí:

• ORG_NAME es el nombre de tu organización de Apigee.

Obtener detalles del espacio

Para realizar esta tarea, necesitas el permiso apigee.spaces.get.

Consola de Apigee

Para ver los detalles del espacio en la IU de Apigee, haz lo siguiente:

1. En la IU de Apigee en la consola de Cloud, ve a la página Spaces.
2. Haz clic en el nombre del espacio que deseas ver. En la página de detalles, se muestran el Nombre, Nombre visible, los detalles de acceso, y la lista de Miembros.

API de Apigee

Para obtener los detalles de un espacio, usa el siguiente comando:

curl -X GET -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME"

Aquí:

• ORG_NAME es el nombre de tu organización de Apigee.
• SPACE_NAME es el nombre del espacio.

Actualizar un espacio

Para realizar esta tarea, necesitas el permiso apigee.spaces.update.

Puedes modificar el Nombre visible de un espacio existente. El nombre único no se puede cambiar después de la creación.

Consola de Apigee

Para actualizar un espacio en la IU de Apigee, haz lo siguiente:

1. En la IU de Apigee en la consola de Cloud, ve a la página Spaces y haz clic en el nombre del espacio que deseas actualizar.
2. Haz clic en el botón editar (ícono de lápiz) junto al encabezado "Detalles del espacio".
3. Modifica el Nombre visible según sea necesario.
4. Haz clic en Guardar.

API de Apigee

Para actualizar un espacio con la API, usa el siguiente comando:

curl -X PATCH -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME" \
      --data-raw '{
        "displayName":"DISPLAY_NAME"
      }'

Aquí:

• ORG_NAME es el nombre de tu organización de Apigee.
• SPACE_NAME es el nombre del espacio.
• DISPLAY_NAME es el nuevo nombre visible del espacio.

Borrar un espacio

Para realizar esta tarea, necesitas el permiso apigee.spaces.delete.

Consola de Apigee

Advertencia: Borrar un espacio quita de inmediato el acceso de sus miembros a los proxies de API, los flujos compartidos y los productos de API que pertenecen al espacio. No podrás deshacer esta acción.

Para borrar un espacio con la IU de Apigee, haz lo siguiente:

1. En la IU de Apigee en la consola de Cloud, ve a la página Spaces.
2. Haz clic en Borrar en la fila del espacio que deseas borrar.
3. En el cuadro de diálogo de confirmación, escribe el nombre exacto del espacio para confirmar.
4. Haz clic en Borrar.

Nota: Si el espacio aún contiene recursos activos, la eliminación fallará. Borra o mueve todos los recursos del espacio antes de intentar borrarlo.

API de Apigee

Antes de borrar un espacio con la API, asegúrate de que se hayan borrado o movido todos los recursos en el espacio.

curl -X DELETE -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME"

Aquí:

• ORG_NAME es el nombre de tu organización de Apigee.
• SPACE_NAME es el nombre del espacio.

Si intentas borrar un espacio que aún contiene recursos activos, la eliminación fallará con una respuesta similar a la siguiente:

{
  "error": {
    "code": 400,
    "message": "Space \"red\" has resources associated with it. Please delete the resources before deleting the space.",
    "status": "FAILED_PRECONDITION"
  }
}

Para resolver este error, borra o mueve todos los recursos del espacio antes de intentar borrarlo.

¿Qué sigue?

• Obtén más información sobre Espacios de Apigee.
• Obtén más información para administrar recursos de API con Apigee Spaces.
• Revisa la documentación de Identity and Access Management (IAM).