accessgroups

Download Spec

get /authorizer/api/v1/accessgroups

Get access groups

offset

int

Offset from which to start fetching objects

Default
0

limit

int

Maximum number of objects to return

Default
100

sortkey

string

Sort by specific object property

Default
"id"

sortdir

string

Sort direction, asc or desc

Default
"ASC"
Enum
  • ASC
  • DESC

Response

ExamplesSchema

Successful request, respond with a list of access groups

{
  "count": 123,
  "items": [
    {
      "id": "string",
      "name": "string",
      "comment": "string",
      "ca_id": "string",
      "primary_ca_id": "string",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}

post /authorizer/api/v1/accessgroups

Create access group

name

string

human readable name for access group

comment

string

optional human readable description

Request

{
  "name": "string",
  "comment": "string"
}

Response

ExamplesSchema

Access group successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

post /authorizer/api/v1/accessgroups/search

Get access groups

keywords

string

Comma or space-separated strings to search across all access group attributes. The leading and trailing wildcards for the keywords are implicit.

Request

{
  "keywords": "string"
}

Response

ExamplesSchema

Successful request, respond with a list of matching access groups

{
  "count": 123,
  "items": [
    {
      "id": "string",
      "name": "string",
      "comment": "string",
      "ca_id": "string",
      "primary_ca_id": "string",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}

get /authorizer/api/v1/accessgroups/{id}

Get access group

id

string

required

Access group id

Response

ExamplesSchema

Successful request, respond with an access group object

{
  "id": "string",
  "name": "string",
  "comment": "string",
  "ca_id": "string",
  "primary_ca_id": "string",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
}

put /authorizer/api/v1/accessgroups/{id}

Update access group

name

string

human readable name for access group

comment

string

optional human readable description

Request

{
  "name": "string",
  "comment": "string"
}

Response

ExamplesSchema

Access group successfully updated

Empty response

delete /authorizer/api/v1/accessgroups/{id}

Delete access group

id

string

required

Access group id

Response

ExamplesSchema

Access group successfully deleted

Empty response

post /authorizer/api/v1/accessgroups/{id}/cas

Renew CA key

id

string

required

Access group ID

Response

ExamplesSchema

Successful request, respond with the new CA key ID

"5bf77342-221c-11ee-be56-0242ac120002"

delete /authorizer/api/v1/accessgroups/{id}/cas/{ca_id}

Revoke CA key

id

string

required

Access group ID

ca_id

string

required

CA key ID

Response

ExamplesSchema

Successful request

Empty response

Was this page helpful?