[{"label":"Latest (v1.0)","version":"latest"}]
csp
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
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations/{userInvitationId}
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
string
userInvitationId
Required
Unique identifier (GUID) of the invitation.
Parameter Serialization Style:
simple Explode:false
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
UserOrganizationInvitationResponse
of type application/json
{
"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"
}
string
username
Required
The username of the user.
integer as int64
expirationTime
Optional
The expiration time of the invitation.
integer as int64
generatedAt
Optional
The creation timestamp in milliseconds.
string
generatedBy
Optional
The Creator ot the invitation (usually client identifier).
string
invitationLink
Optional
Deprecated: the common Invitation Link.
string
invitedByUsername
Optional
Invited By, specify the actual user who is inviting.
array of
string
orgRoleNames
Optional
List of organization role names.
array of
string
customGroupsIds
Optional
Custom Groups Identifiers (relevant only for invite).
integer as int64
redeemedAt
Optional
The redemption timestamp in milliseconds.
string
redeemedBy
Optional
The name of the invitation redeemer.
string
refLink
Optional
The reference link of the Invitation.
integer as int64
revokedAt
Optional
The revoke timestamp in milliseconds.
string
revokedBy
Optional
The name of invitation revoker.
string
status
Optional
The status of the invitation.
Possible values are: AVAILABLE , REDEEMED , REVOKED
Errors
Code Samples
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations/{userInvitationId}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Organization Operations
post
post
delete
