Endpoint

/v1/auth/roles/{role_name}/members

GET

List all members of a role.

Parameters

Name Description Required
role_name The name of the role (This page URL-encodes the name for you) Yes
after Return entries after the given key (keys are returned in the paging object) No
limit Return no more than this many entries; the system may choose a smaller limit. No

Response

Codes

Code Description
200 Return value on success

POST

Assign a member to a role

Parameters

Name Description Required
role_name The name of the role (This page URL-encodes the name for you) Yes

Request

Schema

{
  "description": "api_identity",
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "enum": [
        "LOCAL",
        "API_NULL_DOMAIN",
        "WORLD",
        "POSIX_USER",
        "POSIX_GROUP",
        "ACTIVE_DIRECTORY",
        "API_INVALID_DOMAIN",
        "API_RESERVED_DOMAIN",
        "API_INTERNAL_DOMAIN",
        "API_OPERATOR_DOMAIN",
        "API_CREATOR_DOMAIN"
      ],
      "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
    },
    "auth_id": {
      "description": "auth_id",
      "type": "string"
    },
    "uid": {
      "description": "uid",
      "type": "number"
    },
    "gid": {
      "description": "gid",
      "type": "number"
    },
    "sid": {
      "description": "sid",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_identity",
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "enum": [
        "LOCAL",
        "API_NULL_DOMAIN",
        "WORLD",
        "POSIX_USER",
        "POSIX_GROUP",
        "ACTIVE_DIRECTORY",
        "API_INVALID_DOMAIN",
        "API_RESERVED_DOMAIN",
        "API_INTERNAL_DOMAIN",
        "API_OPERATOR_DOMAIN",
        "API_CREATOR_DOMAIN"
      ],
      "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
    },
    "auth_id": {
      "description": "auth_id",
      "type": "string"
    },
    "uid": {
      "description": "uid",
      "type": "number"
    },
    "gid": {
      "description": "gid",
      "type": "number"
    },
    "sid": {
      "description": "sid",
      "type": "string"
    },
    "name": {
      "description": "name",
      "type": "string"
    }
  }
}