Sign in
service-provider-controller

Send email invitation to the specified email address.

Send email invitation to the specified email address.

post/api/serviceProviders/{serviceProviderId}/invitations

Path parameters

serviceProviderIdstring required

serviceProviderId

Request body

availableToDestinationboolean
codestring
destIdstring
destNamestring
destType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'
emailDetailsobject
emailTostring
footerstring
idstring
notestring
permittedOperationsstring[]
previousMessageIdstring
readCountinteger
secureContentstring
sourceIdstring
sourceInfoSourceInfo
sourceNamestring
sourceType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'
status'ACTIVE' | 'ASSOC_REQ_ACCEPTED' | 'ASSOC_REQ_DECLINED' | 'DELETED' | 'EXPIRED' | 'INVITE_ACCEPTED' | 'INVITE_DECLINED' | 'NOT_SENT' | 'PENDING'
subjectstring
type'ASSOCIATION_REQUEST' | 'CREDENTIAL' | 'INVITATION' | 'NOTICE' | 'PERSON_NOTIFICATION'

Response

Created

accessPolicyAccessPolicyMessageSourceView
availableToDestinationboolean
createdDtmTimestampMessageSourceView
destIdstring
destNamestring
destType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'
emailTostring
expiringDtmTimestampMessageSourceView
footerstring
idstring
infoMessageInfoMessageSourceView
lastUpdatedDtmTimestampMessageSourceView
notBeforeDtmTimestampMessageSourceView
notestring
previousMessageIdstring
readCountinteger
secureContentstring
sourceIdstring
sourceInfoSourceInfoMessageSourceView
sourceNamestring
sourceType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'
status'ACTIVE' | 'ASSOC_REQ_ACCEPTED' | 'ASSOC_REQ_DECLINED' | 'DELETED' | 'EXPIRED' | 'INVITE_ACCEPTED' | 'INVITE_DECLINED' | 'NOT_SENT' | 'PENDING'
subjectstring
type'ASSOCIATION_REQUEST' | 'CREDENTIAL' | 'INVITATION' | 'NOTICE' | 'PERSON_NOTIFICATION'

Changes

No recorded changes to this endpoint across all 1 revision of this API.