Endpoint /admin/securityprofiles/{id}

GET https://example.com/admin/securityprofiles/{id}

GET

Gets a specific security profile based on a given ID.

Examples

The following sample returns security profile information for the request profile with the given ID 2.

HTTP

# Request:
curl --location --request GET 'https://trial.dsserver.io/admin/securityprofiles/1' \
    --header 'Authorization: Basic YWRtaW46YWRtaW5hZG1pbg=='

# Result:
{
    "id": 1,
    "name": "Document processing tests",
    "allowClientCredentialsGrantType": true,
    "clientCredentials": {
        "id": "dsserver.lOsVIXdaffsfmT9fUQt8x8cOApWLCH",
        "secret": "CBxAjldfsgdhBRuUcBKmPT7SLaIXcof3xYn",
        "authorizedRedirectUris": [
            "https://www.textcontrol.com"
        ]
    },
    "creationDate": "2021-05-27T06:16:38.603-07:00",
    "expiryDate": null,
    "isExpired": false,
    "hasRedirectUriAuthorized": true
}

Authorization

This endpoint supports the Basic authorization method:

Basic

Header Field	Description
Authorization	The username "admin" and your admin password are combined into a string separated by a colon, e.g.: admin:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string. For example: Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Success Response

Status	Description
200	On success, the HTTP status code in the response header is 200 (OK). The return value is a security profile object.

Error Response

Status	Description
401	A 401 (Unauthorized) is returned, if the user is not authorized.
400	A 400 (Bad Request) is returned, if the given ID doesn´t match an existing security profile.