Auth0 · Schema

GetOrganizationInvitationResponseContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
id	string	The id of the user invitation.
organization_id	string	Organization identifier.
inviter	object
invitee	object
invitation_url	string	The invitation url to be send to the invitee.
created_at	string	The ISO 8601 formatted timestamp representing the creation time of the invitation.
expires_at	string	The ISO 8601 formatted timestamp representing the expiration time of the invitation.
client_id	string	Auth0 client ID. Used to resolve the application's login initiation endpoint.
connection_id	string	The id of the connection to force invitee to authenticate with.
app_metadata	object
user_metadata	object
roles	array	List of roles IDs to associated with the user.
ticket_id	string	The id of the invitation ticket

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetOrganizationInvitationResponseContent",
  "title": "GetOrganizationInvitationResponseContent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "The id of the user invitation.",
      "default": "uinv_0000000000000001",
      "format": "user-invitation-id"
    },
    "organization_id": {
      "type": "string",
      "description": "Organization identifier.",
      "maxLength": 50,
      "format": "organization-id"
    },
    "inviter": {
      "$ref": "#/components/schemas/OrganizationInvitationInviter"
    },
    "invitee": {
      "$ref": "#/components/schemas/OrganizationInvitationInvitee"
    },
    "invitation_url": {
      "type": "string",
      "description": "The invitation url to be send to the invitee.",
      "default": "https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme",
      "format": "strict-https-uri"
    },
    "created_at": {
      "type": "string",
      "description": "The ISO 8601 formatted timestamp representing the creation time of the invitation.",
      "default": "2020-08-20T19:10:06.299Z",
      "format": "date-time"
    },
    "expires_at": {
      "type": "string",
      "description": "The ISO 8601 formatted timestamp representing the expiration time of the invitation.",
      "default": "2020-08-27T19:10:06.299Z",
      "format": "date-time"
    },
    "client_id": {
      "type": "string",
      "description": "Auth0 client ID. Used to resolve the application's login initiation endpoint.",
      "default": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
      "format": "client-id"
    },
    "connection_id": {
      "type": "string",
      "description": "The id of the connection to force invitee to authenticate with.",
      "default": "con_0000000000000001",
      "format": "connection-id"
    },
    "app_metadata": {
      "$ref": "#/components/schemas/AppMetadata"
    },
    "user_metadata": {
      "$ref": "#/components/schemas/UserMetadata"
    },
    "roles": {
      "type": "array",
      "description": "List of roles IDs to associated with the user.",
      "minItems": 1,
      "items": {
        "type": "string",
        "format": "role-id"
      }
    },
    "ticket_id": {
      "type": "string",
      "description": "The id of the invitation ticket",
      "format": "ticket-id"
    }
  }
}