Get User Invitation By Organization ID And User Invitation ID
DescriptionGet invitation of a user in an organization (by invitation id).
Access Policy
Role | User Accounts | Service Accounts (Client Credentials Applications) |
---|---|---|
Organization Owner | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Unique identifier (GUID) of the invitation.
Authentication
Response
Response BodyResponse Body
{
"customGroups": [
{
"customRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"organizationRoles": [
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"ownerOrgId": "string",
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
}
],
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
],
"customGroupsIds": [
"string"
],
"customRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"expirationTime": 0,
"generatedAt": 0,
"generatedBy": "string",
"invitationLink": "string",
"invitedByUsername": "string",
"orgRoleNames": [
"string"
],
"organizationRoles": [
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"redeemedAt": 0,
"redeemedBy": "string",
"refLink": "string",
"revokedAt": 0,
"revokedBy": "string",
"serviceRolesDtos": [
{
"serviceDefinitionLink": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
}
],
"status": "AVAILABLE",
"username": "string"
}
The username of the user.
The expiration time of the invitation.
The creation timestamp in milliseconds.
The Creator ot the invitation (usually client identifier).
Deprecated: the common Invitation Link.
Invited By, specify the actual user who is inviting.
List of organization role names.
Custom Groups Identifiers (relevant only for invite).
The redemption timestamp in milliseconds.
The name of the invitation redeemer.
The reference link of the Invitation.
The revoke timestamp in milliseconds.
The name of invitation revoker.
The status of the invitation.
Possible values are: AVAILABLE , REDEEMED , REVOKED
Errors
Code Samples
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_owner
x-slo-tier: TIER2