Docs Home

/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones y equipos

Organizaciones

Actualizar una organización

Cambia el nombre de un proyecto.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /orgs/{ORG-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	El identificador único de la organización.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
Nombre	string	Requerido	El nuevo nombre de la organización.

Respuesta

Nombre	Tipo	Descripción
`id`	ObjectId	Identificador único para la organización.
`isDeleted`	booleano	Bandera que indica si la organización está borrada.
`links`	arreglo de documentos	Uno o más enlaces a sub-recursos y/o recursos relacionados. Las relaciones entre las URL se explican en la Especificación de Enlaces Web.
`name`	string	Nuevo nombre de la organización.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}?pretty=true" \
     --data '
     {
       "name" :  "Organization Name 1"
     }'

Respuesta de ejemplo

1 {
2   "id": "{ORG-ID}",
3   "isDeleted": false,
4   "links": [{
5       "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
6       "rel": "self"
7     },
8     {
9       "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups",
10       "rel": "http://mms.mongodb.com/groups"
11     },
12     {
13       "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams",
14       "rel": "http://mms.mongodb.com/teams"
15     },
16     {
17       "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/users",
18       "rel": "http://mms.mongodb.com/users"
19     }
20   ],
21   "name": "Organization Name 1"
22 }

Volver

Actualizar roles

Borrar

1	{
2	"id": "{ORG-ID}",
3	"isDeleted": false,
4	"links": [{
5	"href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
6	"rel": "self"
7	},
8	{
9	"href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups",
10	"rel": "http://mms.mongodb.com/groups"
11	},
12	{
13	"href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams",
14	"rel": "http://mms.mongodb.com/teams"
15	},
16	{
17	"href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/users",
18	"rel": "http://mms.mongodb.com/users"
19	}
20	],
21	"name": "Organization Name 1"
22	}