Skip to content
This repository has been archived by the owner on Oct 11, 2023. It is now read-only.

Latest commit

 

History

History
482 lines (324 loc) · 9.76 KB

group.md

File metadata and controls

482 lines (324 loc) · 9.76 KB
Raw

Group

Group API

Attributes

Name Type Description Example
createAt date-time Group creation date "2015-01-01T12:00:00Z"
id uuid Unique group identifier "01234567-89ab-cdef-0123-456789abcdef"
name string Group name "group1"
org string Group organization "tecsisa"
path string Group location "/example/admin/"
updateAt date-time The date timestamp of the last update "2015-01-01T12:00:00Z"
urn string Group's Uniform Resource Name "urn:iws:iam:tecsisa:group/example/admin/group1"

Group Create

Create a new group

POST /api/v1/organizations/{organization_id}/groups

Required Parameters

Name Type Description Example
name string Group name "group1"
path string Group location "/example/admin/"

Curl Example

$ curl -n -X POST /api/v1/organizations/$ORGANIZATION_ID/groups \
  -d '{
  "name": "group1",
  "path": "/example/admin/"
}' \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 201 Created

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "group1",
  "path": "/example/admin/",
  "createAt": "2015-01-01T12:00:00Z",
  "updateAt": "2015-01-01T12:00:00Z",
  "urn": "urn:iws:iam:tecsisa:group/example/admin/group1",
  "org": "tecsisa"
}

Group Update

Update an existing group

PUT /api/v1/organizations/{organization_id}/groups/{group_name}

Required Parameters

Name Type Description Example
name string Group name "group1"
path string Group location "/example/admin/"

Curl Example

$ curl -n -X PUT /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME \
  -d '{
  "name": "group1",
  "path": "/example/admin/"
}' \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "group1",
  "path": "/example/admin/",
  "createAt": "2015-01-01T12:00:00Z",
  "updateAt": "2015-01-01T12:00:00Z",
  "urn": "urn:iws:iam:tecsisa:group/example/admin/group1",
  "org": "tecsisa"
}

Group Delete

Delete an existing group

DELETE /api/v1/organizations/{organization_id}/groups/{group_name}

Curl Example

$ curl -n -X DELETE /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 202 Accepted

Group Get

Get an existing group

GET /api/v1/organizations/{organization_id}/groups/{group_name}

Curl Example

$ curl -n /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "group1",
  "path": "/example/admin/",
  "createAt": "2015-01-01T12:00:00Z",
  "updateAt": "2015-01-01T12:00:00Z",
  "urn": "urn:iws:iam:tecsisa:group/example/admin/group1",
  "org": "tecsisa"
}

Organization's groups

Attributes

Name Type Description Example
groups array List of groups ["groupName1, groupName2"]
limit integer The maximum number of items in the response (as set in the query or by default) 20
offset integer The offset of the items returned (as set in the query or by default) 0
total integer The total number of items available to return 2

Organization's groups List

List all organization's groups

GET /api/v1/organizations/{organization_id}/groups?PathPrefix={optional_path_prefix}&Offset={optional_offset}&Limit={optional_limit}&OrderBy={columnName-desc}

Curl Example

$ curl -n /api/v1/organizations/$ORGANIZATION_ID/groups?PathPrefix=$OPTIONAL_PATH_PREFIX&Offset=$OPTIONAL_OFFSET&Limit=$OPTIONAL_LIMIT&OrderBy=$COLUMNNAME-DESC \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "groups": [
    "groupName1, groupName2"
  ],
  "offset": 0,
  "limit": 20,
  "total": 2
}

All groups

Attributes

Name Type Description Example
groups/name string Group name "group1"
groups/org string Group organization "tecsisa"
limit integer The maximum number of items in the response (as set in the query or by default) 20
offset integer The offset of the items returned (as set in the query or by default) 0
total integer The total number of items available to return 1

All groups List

List all groups

GET /api/v1/groups?PathPrefix={optional_path_prefix}&Offset={optional_offset}&Limit={optional_limit}&OrderBy={columnName-desc}

Curl Example

$ curl -n /api/v1/groups?PathPrefix=$OPTIONAL_PATH_PREFIX&Offset=$OPTIONAL_OFFSET&Limit=$OPTIONAL_LIMIT&OrderBy=$COLUMNNAME-DESC \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "groups": [
    {
      "org": "tecsisa",
      "name": "group1"
    }
  ],
  "offset": 0,
  "limit": 20,
  "total": 1
}

Member

Group members

Attributes

Name Type Description Example
limit integer The maximum number of items in the response (as set in the query or by default) 20
members/joined date-time When relationship was created "2015-01-01T12:00:00Z"
members/user string External ID "member1"
offset integer The offset of the items returned (as set in the query or by default) 0
total integer The total number of items available to return 1

Member Add

Add member to a group.

POST /api/v1/organizations/{organization_id}/groups/{group_name}/users/{user_id}

Curl Example

$ curl -n -X POST /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME/users/$USER_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 202 Accepted

Member Remove

Remove member from a group

DELETE /api/v1/organizations/{organization_id}/groups/{group_name}/users/{user_id}

Curl Example

$ curl -n -X DELETE /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME/users/$USER_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 202 Accepted

Member List

List members of a group

GET /api/v1/organizations/{organization_id}/groups/{group_name}/users?Offset={optional_offset}&Limit={optional_limit}&OrderBy={columnName-desc}

Curl Example

$ curl -n /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME/users?Offset=$OPTIONAL_OFFSET&Limit=$OPTIONAL_LIMIT&OrderBy=$COLUMNNAME-DESC \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "members": [
    {
      "user": "member1",
      "joined": "2015-01-01T12:00:00Z"
    }
  ],
  "offset": 0,
  "limit": 20,
  "total": 1
}

Group Policies

Attached Policies

Attributes

Name Type Description Example
limit integer The maximum number of items in the response (as set in the query or by default) 20
offset integer The offset of the items returned (as set in the query or by default) 0
policies/attached date-time When relationship was created "2015-01-01T12:00:00Z"
policies/policy string Policy name "policyName1"
total integer The total number of items available to return 1

Group Policies Attach

Attach policy to group

POST /api/v1/organizations/{organization_id}/groups/{group_name}/policies/{policy_id}

Curl Example

$ curl -n -X POST /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME/policies/$POLICY_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 202 Accepted

Group Policies Detach

Detach policy from group

DELETE /api/v1/organizations/{organization_id}/groups/{group_name}/policies/{policy_id}

Curl Example

$ curl -n -X DELETE /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME/policies/$POLICY_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 202 Accepted

Group Policies List

List attach policies

GET /api/v1/organizations/{organization_id}/groups/{group_name}/policies?Offset={optional_offset}&Limit={optional_limit}&OrderBy={columnName-desc}

Curl Example

$ curl -n /api/v1/organizations/$ORGANIZATION_ID/groups/$GROUP_NAME/policies?Offset=$OPTIONAL_OFFSET&Limit=$OPTIONAL_LIMIT&OrderBy=$COLUMNNAME-DESC \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "policies": [
    {
      "policy": "policyName1",
      "attached": "2015-01-01T12:00:00Z"
    }
  ],
  "offset": 0,
  "limit": 20,
  "total": 1
}