Skip to main content
API docs by Redocly

User Invitations (0.0.25)

Download OpenAPI specification:Download

User Invitation

Lists the invitations by their current state Deprecated

Lists the invitations by their current state

Authorizations:
ApplicationToken
query Parameters
resourceId
string
Default: ""

The resourceId of the project that you want to return

invitationState
required
string (StateEnum)
Enum: "PENDING" "CANCELED" "ACCEPTED" "REJECTED" "EXPIRED"

State you want to perform an actions on

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invites a user to Marco Deprecated

Authorizations:
ApplicationToken
query Parameters
saml
boolean
Default: false

Sets if the invitation is for a user using SAML authentication

organizationId
required
string

Organization Id you want to perform an actions

Request Body schema: application/json
createdByIdentity
string
dateCreated
integer <int64>
emailSubject
string
id
integer <int64>
Array of objects (Role)
invitationState
string (StateEnum)
Enum: "PENDING" "CANCELED" "ACCEPTED" "REJECTED" "EXPIRED"
invitationToken
string
message
string
organizationId
string
userEmail
string <email>

Responses

Request samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}

Response samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}

Use to respond to an existing invitation Deprecated

Authorizations:
ApplicationToken
query Parameters
invitationToken
required
string

The Invitation token that you want to perform an actions

Responses

Response samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}

Cancel existing invitations Deprecated

Cancel existing user invitations

Authorizations:
ApplicationToken
query Parameters
email
required
string

Email you want to perform an actions on

Responses

Use to respond to an existing invitation Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
createdByIdentity
string
dateCreated
integer <int64>
emailSubject
string
id
integer <int64>
Array of objects (Role)
invitationState
string (StateEnum)
Enum: "PENDING" "CANCELED" "ACCEPTED" "REJECTED" "EXPIRED"
invitationToken
string
message
string
organizationId
string
userEmail
string <email>

Responses

Request samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}

Response samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}

Super User Invitation

Gets All Organizations Deprecated

Authorizations:
ApplicationToken
query Parameters
resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{ }

Get Identities in resources Deprecated

Authorizations:
ApplicationToken
path Parameters
identityId
required
string

Identity Id you want to perform an actions on

query Parameters
resources
required
Array of strings

Resource you want to perform an actions

Responses

Response samples

Content type
application/json
{ }

Deletes a Resource Identity Role Deprecated

Authorizations:
ApplicationToken
query Parameters
resourceId
required
string
marcoId
required
string

MarcoId you want to perform an actions on

role
required
string

Role you want to perform an actions on

Responses

Create a Resource Identity Role Deprecated

Authorizations:
ApplicationToken
query Parameters
resourceId
required
string
marcoId
required
string

MarcoId you want to perform an actions on

role
required
string

Role you want to perform an actions on

Responses

Response samples

Content type
application/json
{ }

Lists all the roles available to a user Deprecated

Lists all the roles available to a user

Authorizations:
ApplicationToken

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get Identities containing part of Identity Id Deprecated

Authorizations:
ApplicationToken
path Parameters
identityId
required
string

Identity Id you want to perform an actions on

Responses

Response samples

Content type
application/json
{ }

Get Identities by Resource Id Deprecated

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

Resource Id you want to perform actions on

Responses

Response samples

Content type
application/json
{ }

Get all Identity Permissions for a user Deprecated

Authorizations:
ApplicationToken
query Parameters
identifier
required
string

Email you want to perform an actions on

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Get Organization by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
organizationId
required
string

Organization Id you want to perform an actions on

Responses

Response samples

Content type
application/json
{ }

Get All Resource Identity Roles Deprecated

Authorizations:
ApplicationToken
query Parameters
resource
required
string

Resource Id you want to perform actions against

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{ }

Get all resources by type Deprecated

Authorizations:
ApplicationToken
query Parameters
resourceType
required
string

The Resource Type you want to perform an actions

organization
string

Organization Id you want to perform an actions

project
string

Project Id you want to perform an actions

resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{ }

Invites a user to Marco Deprecated

Authorizations:
ApplicationToken
query Parameters
saml
boolean
Default: false

Sets if the invitation is for a user using SAML authentication

organizationId
string

Organization Id you want to perform an actions

Request Body schema: application/json
createdByIdentity
string
dateCreated
integer <int64>
emailSubject
string
id
integer <int64>
Array of objects (Role)
invitationState
string (StateEnum)
Enum: "PENDING" "CANCELED" "ACCEPTED" "REJECTED" "EXPIRED"
invitationToken
string
message
string
organizationId
string
userEmail
string <email>

Responses

Request samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}

Response samples

Content type
application/json
{
  • "createdByIdentity": "string",
  • "dateCreated": 0,
  • "emailSubject": "string",
  • "id": 0,
  • "invitationResourceRoles": [
    ],
  • "invitationState": "PENDING",
  • "invitationToken": "string",
  • "message": "string",
  • "organizationId": "string",
  • "userEmail": "user@example.com"
}