Skip to content

Latest commit

 

History

History
255 lines (169 loc) · 3.97 KB

user.md

File metadata and controls

255 lines (169 loc) · 3.97 KB

User

User API

Attributes

Name Type Description Example
createdAt date-time User creation date "2015-01-01T12:00:00Z"
externalId string User's external identifier "user1"
id uuid Unique user identifier "01234567-89ab-cdef-0123-456789abcdef"
path string User location "/example/admin/"
urn string User's Uniform Resource Name "urn:iws:iam::user/example/admin/user1"

User Create

Create a new user.

POST /api/v1/users

Required Parameters

Name Type Description Example
externalId string User's external identifier "user1"
path string User location "/example/admin/"

Curl Example

$ curl -n -X POST /api/v1/users \
  -d '{
  "externalId": "user1",
  "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",
  "externalId": "user1",
  "path": "/example/admin/",
  "createdAt": "2015-01-01T12:00:00Z",
  "urn": "urn:iws:iam::user/example/admin/user1"
}

User Update

Update an existing user.

PUT /api/v1/users/{user_externalID}

Required Parameters

Name Type Description Example
path string User location "/example/admin/"

Curl Example

$ curl -n -X PUT /api/v1/users/$USER_EXTERNALID \
  -d '{
  "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",
  "externalId": "user1",
  "path": "/example/admin/",
  "createdAt": "2015-01-01T12:00:00Z",
  "urn": "urn:iws:iam::user/example/admin/user1"
}

User Delete

Delete an existing user.

DELETE /api/v1/users/{user_externalID}

Curl Example

$ curl -n -X DELETE /api/v1/users/$USER_EXTERNALID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 202 Accepted

User Get

Get an existing user.

GET /api/v1/users/{user_externalID}

Curl Example

$ curl -n /api/v1/users/$USER_EXTERNALID \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "externalId": "user1",
  "path": "/example/admin/",
  "createdAt": "2015-01-01T12:00:00Z",
  "urn": "urn:iws:iam::user/example/admin/user1"
}

Attributes

Name Type Description Example
users array User identifiers ["User1","User2"]

User List All

List all users filtered by PathPrefix.

GET /api/v1/users?PathPrefix={optional_path_prefix}

Curl Example

$ curl -n /api/v1/users?PathPrefix=$OPTIONAL_PATH_PREFIX \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "users": [
    "User1",
    "User2"
  ]
}

Attributes

Name Type Description Example
groups/name string Group name "group1"
groups/org string Group organization "tecsisa"

List user groups

List all groups that a user is a member.

GET /api/v1/users/{user_externalId}/groups

Curl Example

$ curl -n /api/v1/users/$USER_EXTERNALID/groups \
  -H "Authorization: Basic or Bearer XXX"

Response Example

HTTP/1.1 200 OK

{
  "groups": [
    {
      "org": "tecsisa",
      "name": "group1"
    }
  ]
}