[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Resend User Invitation

Description

Resends an invitation by email to a user in an organization.

Request

Request

URL

URL


post
https://{api_host}/v1/orgs/{orgId}/invitations/resend-email
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Request Body

Request Body

UserInvitationEmailsDto of mimetype application/json Optional
{
    "UserInvitationEmailsDto": {
        "emails": [
            "...",
            "..."
        ]
    },
    "emails": [
        "...",
        "..."
    ]
}
array of string
emails Optional

The list of User invitation emails

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted Response Body>

Response Body

202 Accepted

Returns AddUserGenericResponse of type application/json
{
	"failed": {
		"onAdd": {
			"key": "string"
		},
		"onInvite": {
			"key": "string"
		}
	},
	"succeeded": {
		"added": [
			"string"
		],
		"invited": {
			"key": "string"
		}
	}
}
failed Optional

Defines the properties for Add and Invited users which failed.


succeeded Optional

Details of Added and Invited users which succeeded.


207 Response Body>

Response Body

207

Returns AddUserGenericResponse of type application/json
{
	"failed": {
		"onAdd": {
			"key": "string"
		},
		"onInvite": {
			"key": "string"
		}
	},
	"succeeded": {
		"added": [
			"string"
		],
		"invited": {
			"key": "string"
		}
	}
}
failed Optional

Defines the properties for Add and Invited users which failed.


succeeded Optional

Details of Added and Invited users which succeeded.

Errors

Errors

400

Bad Request - The request is either incomplete or incorrect


401

Unauthorized - The user is not authorized to use the API


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"UserInvitationEmailsDto":{"emails":["...","..."]},"emails":["...","..."]}' https://{api_host}/v1/orgs/{orgId}/invitations/resend-email
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body


Feedback

Was this page helpful?