Get Organization Invitations By Organization Id Using GET
Get invitations for specific organization. If expand parameter is passed to the request user invitation roles will be returned in the response.
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
COPY
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Query Parameters
string
expand
Optional
Indicates if response should be expanded, value is ignored - only the existence of parameter is checked.
string
customGroupId
Optional
Unique identifier of the group.
boolean
expandCustomGroups
Optional
Indicates if custom groups response should be expanded.
Responses
200
OK
Returns Array of 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
}
]
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.
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
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