Saltar al contenido principal
GET
https://{tenantDomain}/api/v2
/
organizations
/
{id}
/
invitations
/
{invitation_id}
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.GetOrganizationInvitationRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Organizations.Invitations.Get(
        context.TODO(),
        "id",
        "invitation_id",
        request,
    )
}
{
  "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": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "organization_id": "<string>",
  "roles": [
    "<string>"
  ],
  "ticket_id": "<string>",
  "user_metadata": {}
}

Autorizaciones

​
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
​
invitation_id
string
requerido

El id de la invitación de usuarios.

Parámetros de consulta

​
fields
string

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

​
include_fields
boolean

Indica si los campos especificados se incluyen (true) o se excluyen (false). El valor predeterminado es true.

Respuesta

La invitación se recuperó correctamente.

​
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 forzará a autenticarse a la persona invitada.

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

La marca de tiempo en formato ISO 8601 que representa la fecha y 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 fecha y 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
​
inviter
object
​
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 con el 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.