Obtener invitaciones

Recupera una lista detallada de las invitaciones enviadas a usuarios para una Organización específica. La lista incluye detalles como la información del remitente y del invitado, las URL de invitación y las fechas de creación y vencimiento. Para obtener más información sobre las invitaciones de Organización, consulte Invite Organization Members.

GET https://{tenantDomain}/api/v2/organizations/{id}/invitations

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.ListOrganizationInvitationsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
    }
    client.Organizations.Invitations.List(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "app_metadata": {},
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "connection_id": "con_0000000000000001",
    "created_at": "2020-08-20T19:10:06.299Z",
    "expires_at": "2020-08-27T19:10:06.299Z",
    "id": "uinv_0000000000000001",
    "invitation_url": "https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme",
    "invitee": {
      "email": "[e-mail]"
    },
    "inviter": {
      "name": "Jane Doe"
    },
    "organization_id": "<string>",
    "roles": [
      "<string>"
    ],
    "ticket_id": "<string>",
    "user_metadata": {}
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

Identificador de la organización.

Maximum string length: 50

Parámetros de consulta

page · integer

Índice de la página de resultados que se devolverá. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Cuando es true, devuelve los resultados dentro de un objeto que también contiene start y limit. Cuando es false (valor predeterminado), devuelve directamente un arreglo de resultados. Aún no admitimos devolver el número total de invitaciones.

fields · string

Lista de campos separados por comas que se incluirán o excluirán (según el valor proporcionado para include_fields) en el resultado. Déjela vacía para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false). El valor predeterminado es true.

sort · string

Campo por el que se ordenará. Use field:order, donde order es 1 para ascendente y -1 para descendente. El valor predeterminado es created_at:-1.

Respuesta

200

application/json

Las invitaciones se recuperaron correctamente.

object[]

object

app_metadata · object

Datos relacionados con el usuario que afectan la funcionalidad principal de la aplicación.

client_id · string<client-id> · predeterminado: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID de cliente de Auth0. Se usa para resolver el endpoint de inicio de sesión de la aplicación.

connection_id · string<connection-id> · predeterminado: con_0000000000000001

El id de la conexión con la que se obligará a la persona invitada a autenticarse.

created_at · string<date-time> · predeterminado: 2020-08-20T19:10:06.299Z

La marca de tiempo en formato ISO 8601 que representa la hora de creación de la invitación.

expires_at · string<date-time> · predeterminado: 2020-08-27T19:10:06.299Z

La marca de tiempo en formato ISO 8601 que representa la hora de vencimiento de la invitación.

id · string<user-invitation-id> · predeterminado: uinv_0000000000000001

El id de la invitación de usuarios.

invitation_url · string<strict-https-uri> · predeterminado: https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme

La URL de invitación que se enviará a la persona invitada.

invitee · object

Show child attributes

inviter · object

Show child attributes

organization_id · string<organization-id>

Identificador de la organización.

Maximum string length: 50

roles · string<role-id>[]

Lista de ID de roles que se asociarán al usuario.

Minimum array length: 1

ticket_id · string<ticket-id>

El id del ticket de invitación

user_metadata · object

Datos relacionados con el usuario que no afectan a la funcionalidad principal de la aplicación.