SEsecurityscorecard
invites

create a new invitation for a new user/vendor

Changed on

Create a new invitation for a new user/vendor

post/invitations

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/invitations
  • Auth
    API key in header Authorization

Request body

emailstring email required
first_namestring required
last_namestring required
target_urlstring

optional url to take the invitee to when arriving to the platform. if specified, must be an internal route and only some routes are allowed for security reasons (please validate this in advance, or value could be ignored)

messagestring required

extra messaging for the invitee

branding_urlstring

branding logo url

domainstring

the invited company domain

grade_to_maintainstring

minimum grade that an inviter requests an organization to maintain

days_to_resolve_issueinteger

minimum days to resolve a scorecard issue

sendme_copyboolean

whether we should send a copy to the requesting user

cc_requesterboolean

CC the inviter on the email

sender_emailstring

Email of the user requesting the invite

sender_domainstring

Domain of the user requesting the invite

Example request

{
  "email": "john.smith@example.com",
  "first_name": "John",
  "last_name": "Smith",
  "target_url": "#/scorecard/example.com"
}

Response

new invitation for a new user/vendor

idstring required

invitation id

Changes

  • b465b4846039Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status