RArapid7
Credential

Shared Credential

Changed on

Retrieves the specified shared credential.

get/api/3/shared_credentials/{id}

Request

Path parameters

idinteger required

The identifier of the credential.

Example:17

Response

OK

descriptionstring

The description of the credential.

hostRestrictionstring

The host name or IP address that you want to restrict the credentials to.

idinteger

The identifier of the credential.

namestring required

The name of the credential.

portRestrictioninteger

Further restricts the credential to attempt to authenticate on a specific port.

siteAssignmentstring required

Assigns the shared scan credential either to be available to all sites or to a specific list of sites. The following table describes each supported value:

ValueDescription
"all-sites"The shared scan credential is assigned to all current and future sites.
"specific-sites"The shared scan credential is assigned to zero sites by default. Administrators must explicitly assign sites to the shared credential.
Shared scan credentials assigned to a site can disabled within the site configuration, if needed.
sitesinteger[]

List of site identifiers. These sites are explicitly assigned access to the shared scan credential, allowing the site to use the credential for authentication during a scan. This property can only be set if the value of property siteAssignment is set to "specific-sites". When the property siteAssignment is set to "all-sites", this property will be null.

Changes

  • 3a8197c22d71Revision changes
    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status