Get User Invitation By Organization Id And User Invitation Id Using GET

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 ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations/{userInvitationId}
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

string
userInvitationId
Required

Unique identifier (GUID) of the invitation.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserOrganizationInvitationResponse of type(s) application/json 
{
    "status": "AVAILABLE",
    "refLink": "string",
    "customGroups": [
        {
            "groupType": "string",
            "displayName": "string",
            "id": "string",
            "organizationRoles": [
                {
                    "displayName": "string",
                    "name": "string",
                    "expiresAt": 3609941597,
                    "createdBy": "string",
                    "lastUpdatedDate": "string",
                    "resource": "string",
                    "membershipType": "string",
                    "createdDate": "string",
                    "lastUpdatedBy": "string"
                }
            ],
            "serviceRoles": [
                {
                    "serviceRoleNames": [
                        "string"
                    ],
                    "serviceDefinitionId": "string",
                    "serviceRoles": [
                        {
                            "createdBy": "string",
                            "lastUpdatedBy": "string",
                            "name": "string",
                            "lastUpdatedDate": "string",
                            "expiresAt": 3609941597,
                            "membershipType": "string",
                            "resource": "string",
                            "createdDate": "string"
                        }
                    ]
                }
            ],
            "ownerOrgId": "string",
            "domain": "string",
            "sharedOrgIds": [
                "string"
            ],
            "customRoles": [
                {
                    "createdBy": "string",
                    "lastUpdatedBy": "string",
                    "name": "string",
                    "lastUpdatedDate": "string",
                    "expiresAt": 3609941597,
                    "membershipType": "string",
                    "resource": "string",
                    "createdDate": "string"
                }
            ],
            "usersCount": 0,
            "description": "string"
        }
    ],
    "invitedByUsername": "string",
    "customRoles": [
        {
            "createdBy": "string",
            "lastUpdatedBy": "string",
            "name": "string",
            "lastUpdatedDate": "string",
            "expiresAt": 3609941597,
            "membershipType": "string",
            "resource": "string",
            "createdDate": "string"
        }
    ],
    "orgRoleNames": [
        "string"
    ],
    "organizationRoles": [
        {
            "displayName": "string",
            "name": "string",
            "expiresAt": 3609941597,
            "createdBy": "string",
            "lastUpdatedDate": "string",
            "resource": "string",
            "membershipType": "string",
            "createdDate": "string",
            "lastUpdatedBy": "string"
        }
    ],
    "serviceRolesDtos": [
        {
            "serviceRoleNames": [
                "string"
            ],
            "serviceDefinitionLink": "string",
            "serviceRoles": [
                {
                    "createdBy": "string",
                    "lastUpdatedBy": "string",
                    "name": "string",
                    "lastUpdatedDate": "string",
                    "expiresAt": 3609941597,
                    "membershipType": "string",
                    "resource": "string",
                    "createdDate": "string"
                }
            ]
        }
    ],
    "generatedBy": "string",
    "username": "string",
    "customGroupsIds": [
        "string"
    ],
    "redeemedBy": "string",
    "expirationTime": 0,
    "redeemedAt": 0,
    "generatedAt": 0,
    "revokedBy": "string",
    "invitationLink": "string",
    "revokedAt": 0
}
string
status
Optional

The status of the invitation.

Possible values are : AVAILABLE, REDEEMED, REVOKED,
string
refLink
Optional

The reference link of the Invitation.

array of object
customGroups
Optional

Custom Groups (relevant only for invite).

string
invitedByUsername
Optional

Invited By, specify the actual user who is inviting.

array of object
customRoles
Optional

List of custom role objects.

array of string
orgRoleNames
Optional

List of organization role names.

array of object
organizationRoles
Optional

List of organization role objects.

array of object
serviceRolesDtos
Optional

List of services roles objects.

string
generatedBy
Optional

The Creator ot the invitation (usually client identifier).

string
username
Required

The username of the user.

array of string
customGroupsIds
Optional

Custom Groups Identifiers (relevant only for invite).

string
redeemedBy
Optional

The name of the invitation redeemer.

integer As int64 As int64
expirationTime
Optional

The expiration time of the invitation in days. Default value is 7 days.

integer As int64 As int64
redeemedAt
Optional

The redemption timestamp in milliseconds.

integer As int64 As int64
generatedAt
Optional

The creation timestamp in milliseconds.

string
revokedBy
Optional

The name of invitation revoker.

string
invitationLink
Optional

Deprecated: the common Invitation Link.

integer As int64 As int64
revokedAt
Optional

The revoke timestamp in milliseconds.


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found. | Invitation not found

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations/{userInvitationId}
On This Page
Organization Operations
GET
Get Sub Organizations By Organization Id Using GET
POST
Activate Organization Refresh Tokens Using POST
Deprecated
GET
Get Organization Roles By Organization Id Using GET
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
POST
Assign Roles To Clients On Organization Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
GET
Get Organization Clients By Organization Id Using GET
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
PATCH
Update Organization By Organization Id Using PATCH
GET
Get Organization By Id Using GET
DELETE
Remove Users From Organization By Organization Id Using DELETE
GET
Get Organization Users By Organization Id Using GET
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Invite Users Using POST
GET
Get Organization Invitations By Organization Id Using GET
POST
Link Org To Idp Using POST
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Org Linked Idp Details Using GET
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET