User invitations

User invitations are an alternative method to create users. With a user invitation, there is no need for the user to manually share its public key as the process is fully automated in the backend. Moreover it is possible to create invitations that have an expiration date.

Operações

/v1/domains/{domainId}/users/invitations

Requisição

List user invitations

Segurança

httpAuth

Caminho

domainIdstring, (uuid)obrigatório

Consulta

limitinteger, (int32)

startingAfterstring, (uuid)

sortOrderstring

Enum:"ASC""DESC"

sortBystring

Enum:"Code""ValidUntil""CreatedAt""LastModifiedAt""Alias"

statusArray of strings

Items Enum:"Pending""DeviceRegistered""Expired""Cancelled""Completed""Active"

aliasstring

roles[]Array of strings

curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/v1.34/devbox/v1/domains/{domainId}/users/invitations?limit=0&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortOrder=ASC&sortBy=Code&status=Pending&alias=string&roles%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpo

itemsArray of objectsobrigatório

countinteger, (int32)obrigatório

currentStartingAfterstring or null, (uuid)

nextStartingAfterstring or null, (uuid)

Resposta

{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "651be221-e717-4828-840c-fe29ed82c461",
  "nextStartingAfter": "2e35122f-8704-4d6f-b465-9a3a43a644e9"
}