Skip to content
NimlesNimlesNimles Docs

Get public (non-sensitive) details about an invite

GET
/api/tenant/{tenantId}/Invites/{id}/details
curl --request GET \
  --url https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Invites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/details \
  --header 'Authorization: Bearer <token>'

Gets public (non-sensitive) details about an invite. Intended for the invite-accept landing page so that the recipient can see what they are being invited to before signing in.

Signed in, the caller is told what it can do with the invite (callerStatus), from its account in its home tenant. Anonymous callers and clients are told whether the address has an account in the invite’s tenant, unless signInTenantId names the platform: whether an address has a platform account is never told (see Nimles.Identity.Api.Services.InviteDetailsReader).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

The unique identifier of the invite.

tenantId
required
string format: uuid

Your tenant id.

Query Parameters

Section titled “Query Parameters”
signInTenantId
string format: uuid

The tenant the invitee signs in to: the invite’s (the default) or the platform’s.

Header Parameters

Section titled “Header Parameters”
X-Invite-Code
string

The invite’s code (Nimles.Identity.Api.Controllers.InvitesController.InviteCodeHeader), from the accept link. The inviter’s name and message are told only to one who holds it or is signed in with the invited address, not to anyone who has only the id.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
email
required
string
nullable
roleDefinitionId
required
string format: uuid
roleName
string
nullable
tenantId
string format: uuid
tenantName
string
nullable
organizationId
string format: uuid
nullable
organizationName
string
nullable
resourceGroupId
string format: uuid
nullable
invitedByName
string
nullable
message
string
nullable
status
required
string
nullable
expiresAt
string format: date-time
nullable
isExpired
boolean
accountExists
boolean
ssoAvailable
boolean
callerStatus
string
nullable

Example generated

{
  "email": "example",
  "roleDefinitionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "roleName": "example",
  "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "tenantName": "example",
  "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationName": "example",
  "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "invitedByName": "example",
  "message": "example",
  "status": "example",
  "expiresAt": "2026-04-15T12:00:00Z",
  "isExpired": true,
  "accountExists": true,
  "ssoAvailable": true,
  "callerStatus": "example"
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}