Jump to

• Request
• Response

Get Users

get

/rest/{versionId}/security/users

Use this (GET) method to display SDM users. You can use query parameters with this task.

Request

Path Parameters

• versionId: string

Query Parameters

• ascending(optional): string
• limitation(optional): string
• offset(optional): string
• sort(optional): string
• userGroupName(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : users

Type: object

Show Source

• pageInfo(optional): object PageInfo
• users(optional): array user

{
    "type":"object",
    "properties":{
        "pageInfo":{
            "$ref":"#/definitions/PageInfo"
        },
        "users":{
            "type":"array",
            "xml":{
                "name":"user"
            },
            "items":{
                "$ref":"#/definitions/RestUser"
            }
        }
    },
    "xml":{
        "name":"users"
    }
}

Nested Schema : PageInfo

Type: object

Show Source

• limitation(optional): integer(int32)
• numberOfElements(optional): integer(int64)
• offset(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "limitation":{
            "type":"integer",
            "format":"int32"
        },
        "numberOfElements":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : user

Type: array

Show Source

• Array of: object user

{
    "type":"array",
    "xml":{
        "name":"user"
    },
    "items":{
        "$ref":"#/definitions/RestUser"
    }
}

Nested Schema : user

Type: object

Show Source

• accountExpirationDate(optional): string
• accountExpires(optional): boolean
  Default Value: false
• adminStatus(optional): string
• id(optional): string
• name(optional): string
• operationalStatus(optional): string
• passwordExpirationDate(optional): string
• passwordExpires(optional): boolean
  Default Value: false
• userGroupId(optional): string
• userGroupName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "userGroupName":{
            "type":"string"
        },
        "userGroupId":{
            "type":"string"
        },
        "adminStatus":{
            "type":"string"
        },
        "operationalStatus":{
            "type":"string"
        },
        "accountExpires":{
            "type":"boolean",
            "default":false
        },
        "accountExpirationDate":{
            "type":"string"
        },
        "passwordExpires":{
            "type":"boolean",
            "default":false
        },
        "passwordExpirationDate":{
            "type":"string"
        }
    },
    "xml":{
        "name":"user"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top