Jump to

• Request
• Response

Get Roles

get

/iam/governance/selfservice/api/v1/roles

Returns all the roles in Oracle Identity Manager. The filter query parameter can be used to return a subset of the roles. SCIM filter is accepted. For example the query to get all roles whose name starts with Oracle is "/role?q=Role::Name sw Oracle". The attributes that are to be returned by the role can also be controlled by specifying the fields query parameter.

Request

Supported Media Types

• application/json

Query Parameters

• fields(optional): string
  A Comma-separated list of the attribute names is to be passed to the fields query parameter. For example to get only the role display name, unique name and description the URI is "/role?fields=Role Unique Name,Role Display Name,Role Description" The response contains the Role Key and the Role id which are the unique identifiers for the role.
• q(optional): string
  Search filter to get the records. SCIM filter is accepted. There should not be any spaces for attribute name. If you want to pass space in between attribute name then replace it with "::". Supported attributes in filter are "Role Name etc". Sample value for filter is "Role::Name sw Oracle"

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : BulkRoleGetResponse

Type: object

Show Source

• count(optional): integer
• hasMore(optional): boolean
• roles(optional): array roles
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role"
            }
        }
    }
}

Nested Schema : roles

Type: array

Show Source

• Array of: object Role

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role"
    }
}

Nested Schema : Role

Type: object

Show Source

• fields(optional): array fields
• id(optional): string
• links(optional): array links

{
    "properties":{
        "id":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

• Array of: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Back to Top