Get a specific invitation to an Organization

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

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.GetOrganizationInvitationRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Organizations.Invitations.Get(
        context.TODO(),
        "id",
        "invitation_id",
        request,
    )
}

200

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

Organization identifier.

Maximum string length: 50

invitation_id · string · required

The id of the user invitation.

Query Parameters

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields · boolean

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

Response

200

application/json

Invitation successfully retrieved.

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

The id of the user invitation.

organization_id · string<organization-id>

Organization identifier.

Maximum string length: 50

inviter · object

Show child attributes

invitee · object

Show child attributes

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

The invitation url to be send to the invitee.

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

The ISO 8601 formatted timestamp representing the creation time of the invitation.

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

The ISO 8601 formatted timestamp representing the expiration time of the invitation.

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

Auth0 client ID. Used to resolve the application's login initiation endpoint.

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

The id of the connection to force invitee to authenticate with.

app_metadata · object

Data related to the user that does affect the application's core functionality.

user_metadata · object

Data related to the user that does not affect the application's core functionality.

roles · string<role-id>[]

List of roles IDs to associated with the user.

Minimum array length: 1

ticket_id · string<ticket-id>

The id of the invitation ticket