Sign in
credential-provider-controller

Create an association code for a credential provider.

Create an association code for a credential provider and send the email to the specified address, if provided.

post/api/credentialProviders/{credentialProviderId}/associationRequest

Path parameters

credentialProviderIdstring required

credentialProviderId

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

accessPolicyAccessPolicyMessageSourceWithCodeView
availableToDestinationboolean
codestring
createdDtmTimestampMessageSourceWithCodeView
destIdstring
destNamestring
destType'CREDENTIAL_PROVIDER' | 'PERSON' | 'SERVICE_PROVIDER' | 'SYSTEM'
emailTostring
expiringDtmTimestampMessageSourceWithCodeView
footerstring
idstring
infoMessageInfoMessageSourceWithCodeView
lastUpdatedDtmTimestampMessageSourceWithCodeView
notBeforeDtmTimestampMessageSourceWithCodeView
notestring
previousMessageIdstring
readCountinteger
secureContentstring
sourceIdstring
sourceInfoSourceInfoMessageSourceWithCodeView
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.