GET rbac/access certification campaigns/:access certification campaign id

From Social ID Developers
Jump to: navigation, search

Contents

Description

Returns an Access Certification Campaign.

Resource URL

  GET https://api.socialidnow.com/v1/rbac/access_certification_campaigns/:access_certification_campaign_id

Parameters

URL Parameters

access_certification_campaign_id required access certification campaign identifier.

Authentication

This API requires Account authentication. See Authentication.

Response

Response Status

ok (200) The request was successful.
unauthorized (401) The authentication is wrong. See Authentication.
forbidden (403) The account does not have access to this access certification campaign.
internal_server_error (500) An unknown error happened.

Response Body

The following fields are returned:

id access certification campaign identifier.
name access certification campaign name.
description access certification campaign description.
status access certification campaign status. Possible values: "draft", "scheduled", "starting", "active", "finishing" or "done".
start_date date of access certification campaign start.
end_date date of access certification campaign end.
created_at date of access certification campaign creation.
updated_at date of access certification campaign latest update.

Examples

Request

curl -X GET 'https://api.socialidnow.com/v1/rbac/access_certification_campaigns/1' \
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers

HTTP/1.1 200 Ok
Status: 200

Response Body

{
  "id": 1,
  "name": "First Access Certification Campaign",
  "description": "First Access Certification Campaign description",
  "status": "draft",
  "start_date": null,
  "end_date": null,
  "created_at": "2024-01-10T12:15:00Z",
  "updated_at": "2024-01-10T12:15:00Z"
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox