Get Get Roles | VMware Identity Manager API

Get Get Roles

The role id is a unique internal identifier and can be retrieved using the search API /scim/Roles?filter=

Request

URI

GET

https://{api_host}//SAAS/jersey/manager/api/scim/Roles

COPY

Query Parameters

string

attributes

Optional

list of attributes to return, separated by comma. When specified, the retrieved role(s)will only contain the minimal set of role attributes plus the attributes or sub-attributes explicitly requested, i.e. {urn}:{Attribute name}.{Sub-Attribute name}

attributes example

displayName,meta.version,urn:scim:schemas:extension:workspace:1.0:description,

string

filter

Optional

when specified, only roles matching the filter expression will be returned. The filter must comply with the SCIM specification. Only 'eq','co','sw','gt','ge','lt' and 'le' are currently supported as operators

filter example

displayName co "User"

integer

startIndex

Optional

offset of the first role to return in the list of found roles

startIndex example

integer

count

Optional

the number of found roles to return starting from the given startIndex

count example

Authentication

This operation uses the following authentication methods.

oauth2

Responses

200

successful operation

Returns ResourcesOfRoleResource of type(s) application/json

{
    "totalResults": 0,
    "startIndex": 0,
    "itemsPerPage": 0,
    "Resources": [
        {
            "displayName": "Administrator",
            "resourceDescriptor": {
                "endpoint": "string",
                "description": "string",
                "name": "string",
                "attributeSchemas": [
                    "string"
                ],
                "strictMode": false,
                "scimObject": {
                    "schemas": [
                        "string"
                    ]
                },
                "meta": {
                    "lastModified": "string",
                    "version": "string",
                    "location": "string",
                    "created": "string"
                },
                "externalId": "string",
                "attributes": [
                    {
                        "subAttributes": [
                            "AttributeDescriptor Object"
                        ],
                        "description": "string",
                        "canonicalValues": [
                            {
                                "operation": "string",
                                "type": "string",
                                "primary": false,
                                "value": "string",
                                "display": "string"
                            }
                        ],
                        "dataType": "string",
                        "required": false,
                        "caseExact": false,
                        "name": "string",
                        "readOnly": false,
                        "multiValuedChildName": "string",
                        "multiValued": false,
                        "schema": "string"
                    }
                ],
                "schema": "string",
                "id": "string",
                "resourceDescriptor": "ResourceDescriptor Object"
            },
            "urn:scim:schemas:extension:workspace:1.0": {
                "description": "read-only admin with limited access to file system"
            },
            "scimObject": {
                "schemas": [
                    "string"
                ]
            },
            "meta": {
                "lastModified": "string",
                "version": "string",
                "location": "string",
                "created": "string"
            },
            "externalId": "string",
            "members": [
                {
                    "operation": "string",
                    "type": "string",
                    "primary": false,
                    "value": "string",
                    "display": "string"
                }
            ],
            "id": "string",
            "schemas": [
                "string"
            ]
        }
    ]
}

integer As int64 As int64

totalResults

Optional

totalResults

integer As int64 As int64

startIndex

Optional

startIndex

integer As int32 As int32

itemsPerPage

Optional

itemsPerPage