Get User Invitation By Organization Id And User Invitation Id Using GET
Get invitation of a user in an organization (by invitation id).
Access Policy
Role | User Accounts | Service Accounts (Client Credentials Applications) |
---|---|---|
Organization Admin | ✔️ | ✔️ |
Organization Owner | ✔️ | ✔️ |
Unique identifier (GUID) of the organization.
Unique identifier (GUID) of the invitation.
OK
{
"customGroups": [
{
"customRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "string",
"name": "string",
"resource": "string"
}
],
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "string",
"id": "string",
"organizationRoles": [
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "string",
"name": "string",
"resource": "string"
}
],
"ownerOrgId": "string",
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "string",
"name": "string",
"resource": "string"
}
]
}
],
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
],
"customGroupsIds": [
"string"
],
"customRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "string",
"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": "string",
"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": "string",
"name": "string",
"resource": "string"
}
]
}
],
"status": "AVAILABLE",
"username": "string"
}
Custom Groups (relevant only for invite).
Custom Groups Identifiers (relevant only for invite).
List of custom role objects.
The expiration time of the invitation in days. Default value is 7 days.
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.
List of organization role objects.
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.
List of services roles objects.
The status of the invitation.
The username of the user.
The user is not authorized to use the API
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user is forbidden to use the API
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
Organization with this identifier is not found. | Invitation not found
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user has sent too many requests
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations/{userInvitationId}