PUT/v1/org/permissions

Conceder funções sobre a organização

grant_org_permissions

Exige ORG_MANAGE_USERS. O sujeito é um grupo (group_id) ou um usuário (user_id, por meio do grupo pessoal dele). role_ids são as funções de nível org que o sujeito recebe sobre a organização. Elas substituem as funções anteriores do sujeito sobre este objeto; uma lista vazia remove todas. A função interna admin só pode ser concedida a usuários, não a grupos. Não é possível remover o último administrador.

Autenticação

Envie uma chave de API no cabeçalho Authorization: Authorization: Bearer <chave>.

Corpo da requisição

application/json

Objeto: ObjectGrantRequest

group_idinteger | null
user_idinteger | null
role_idsarray of integerobrigatório

Respostas

200Permissões sobre o objeto depois da alteração, no mesmo formato de `GET …/permissions`.

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: ObjectPermissions

objectGrantObjectobrigatório
addedarray of ObjectGrantobrigatório
inheritedarray of ObjectGrantobrigatório
effectivearray of stringobrigatório
managed_bystring | null
O objeto está bloqueado para visualização (source:<id>): uma fonte no modo de espelhamento define as permissões dele, a herança da coleção e das pastas não se aplica, e as concessões manuais são rejeitadas (409 authz.managed_by_source). null para um objeto comum.

400A requisição é inválida: o valor de um parâmetro ou o estado do objeto não permite a ação (`detail` é uma mensagem).

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

401Nenhuma credencial foi enviada (nem cookie de sessão nem chave de API), ou a chave não foi encontrada.

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

403A ação não é permitida: a função é insuficiente, não há acesso à coleção ou ao cartão, a requisição é executada no modo “View as” ou a organização está suspensa ou excluída (`detail` é um objeto com `code: org_suspended | org_deleted`).

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

404O objeto não existe ou não está disponível para você. A API não confirma que um objeto restrito existe.

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

409O estado do objeto não permite a ação, por exemplo, uma duplicata, uma indexação em andamento ou um job já processado.

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

422Erro de validação: o corpo ou os parâmetros não correspondem ao esquema (`detail` é uma lista de erros de validação), ou o valor de um parâmetro está fora do intervalo (`detail` é uma mensagem).

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

429Requisições demais (`api.rate_limited`), a cota da organização para o minuto, o dia ou o mês se esgotou (`api.quota_exceeded`; `error.details` contém `quota`, `limit` e `reset_at`), o limite da organização foi atingido ou o serviço de respostas está ocupado (`answers.engine_busy`). Aguarde o tempo indicado no cabeçalho `Retry-After`.

Cabeçalhos da resposta

Retry-After
Número de segundos a esperar antes de tentar a requisição novamente.
RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

Códigos de erro

Códigos que este endpoint pode retornar em error.code, além dos códigos gerais de qualquer requisição.

Limites de taxa

As respostas trazem os cabeçalhos RateLimit e RateLimit-Policy e os anteriores X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset. Uma resposta 429 traz Retry-After em segundos: aguarde e tente de novo.

← permissions · Referência da API

curl -X PUT 'https://api.sursa.com/v1/org/permissions' \
  -H "Content-Type: application/json" \
  -d '{"role_ids":[1]}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Testar

Chave de API

A chave fica na memória desta aba e é enviada só para https://api.sursa.com.

As requisições atuam sobre os dados reais da sua organização.

Corpo da requisição (JSON)