Jump to

• Request
• Response
• Examples

Get All Assigned Certifications

get

/iam/governance/selfservice/api/v1/certifications

Returns all the certification assigned to the logged in user.

Request

Supported Media Types

• application/json

Query Parameters

• q(optional): string
  Search filter to get the certifications. SCIM filter is accepted. There should not be any spaces for filter value. If you want to pass space in between attribute values then replace it with "::". Supported attributes in filter are type and userid. Sample value for filter is "type eq Application" or "type eq Role and userid={userId}".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : CertificationsResponse

Type: object

Show Source

• certifications(optional): array certifications
• count(optional): integer
• hasMore(optional): boolean
• totalResult(optional): integer(int32)

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer",
            "format":"int32"
        },
        "certifications":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CertificationInstance"
            }
        }
    }
}

Nested Schema : certifications

Type: array

Show Source

• Array of: object CertificationInstance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CertificationInstance"
    }
}

Nested Schema : CertificationInstance

Type: object

Show Source

• id(optional): string
• links(optional): array links

{
    "properties":{
        "id":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example retrieves all certifications where the state is assigned. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/certifications?q=state+eq+assigned

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications?
offset=1&limit=10&q=state+eq+assigned"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications?
offset=1&limit=10&q=state+eq+assigned"
        }
    ],
    "count": 2,
    "hasMore": false,
    "totalResult": -1,
    "certifications": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/3/tasks/be
a5a9e0-8e4c-455f-a34b-33ca190f0bce"
                }
            ],
            "state": "ASSIGNED",
            "name": "usercert  [ Bud Spencer ] Reassigned [ Ajay Arora ]",
            "type": "User",
            "id": "3",
            "asignee": "aarora",
            "createdDate": "2019-04-01T20:09:53Z",
            "soaTaskId": "d8a1bfb5-3f8d-4f51-b0f8-d24f1a3982a6",
            "taskId": "bea5a9e0-8e4c-455f-a34b-33ca190f0bce"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58"
                }
            ],
            "state": "ASSIGNED",
            "name": "usercert [ Ajay Arora ]",
            "type": "User",
            "id": "21",
            "asignee": "aarora",
            "createdDate": "2019-04-08T16:33:18Z",
            "soaTaskId": "6899dc3d-645c-42b1-8d9d-39eb9719261f",
            "taskId": "e1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58"
        }
    ]
}

Back to Top