Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSubject

Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

Required permissions: rolesanywhere:GetSubject.

Request Syntax


GET /subject/subjectId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

subjectId

The unique identifier of the subject.

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "subject": { 
      "createdAt": "string",
      "credentials": [ 
         { 
            "enabled": boolean,
            "failed": boolean,
            "issuer": "string",
            "seenAt": "string",
            "serialNumber": "string",
            "x509CertificateData": "string"
         }
      ],
      "enabled": boolean,
      "instanceProperties": [ 
         { 
            "failed": boolean,
            "properties": { 
               "string" : "string" 
            },
            "seenAt": "string"
         }
      ],
      "lastSeenAt": "string",
      "subjectArn": "string",
      "subjectId": "string",
      "updatedAt": "string",
      "x509Subject": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

subject

The state of the subject after a read or write operation.

Type: SubjectDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404