Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

List User Roles

get

/services/{version}/authorizations

Required Role: Security

Get the collection of roles in this deployment.

Request

Path Parameters

version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Return the collection of available Authorization Roles.

Root Schema : Oracle GoldenGate Collection of Security Roles

Type: object

Title: Oracle GoldenGate Collection of Security Roles

Show Source

$schema:

Allowed Values: [ "ogg:roleCollection" ]
items(required): array items

Minimum Number of Items: 0

Maximum Number of Items: 32767

{
    "title":"Oracle GoldenGate Collection of Security Roles",
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:roleCollection"
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "roleName":{
                        "description":"Name of security role",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                        "minLength":"1",
                        "maxLength":"256"
                    },
                    "links":{
                        "description":"Links for item",
                        "minItems":"1",
                        "maxItems":"16",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "$schema":{
                                    "enum":[
                                        "ogg:link"
                                    ]
                                },
                                "rel":{
                                    "description":"Relationship of href to the requested link",
                                    "enum":[
                                        "alternate",
                                        "canonical",
                                        "current",
                                        "describedby",
                                        "describes",
                                        "enclosure",
                                        "parent",
                                        "related",
                                        "self",
                                        "first",
                                        "last",
                                        "next",
                                        "previous",
                                        "ogg://service"
                                    ]
                                },
                                "href":{
                                    "description":"An absolute URI for the link",
                                    "type":"string",
                                    "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                                    "minLength":"2",
                                    "maxLength":"4095"
                                },
                                "mediaType":{
                                    "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                                    "type":"string",
                                    "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                                    "minLength":"6",
                                    "maxLength":"255"
                                },
                                "description":{
                                    "description":"A human-readable description that provides information and detail specific to this link.",
                                    "type":"string",
                                    "minLength":"1",
                                    "maxLength":"4095"
                                }
                            },
                            "required":[
                                "rel",
                                "href"
                            ],
                            "additionalProperties":false
                        }
                    }
                },
                "required":[
                    "roleName",
                    "links"
                ],
                "additionalProperties":false
            },
            "minItems":"0",
            "maxItems":"32767"
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 32767

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "roleName":{
                "description":"Name of security role",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                "minLength":"1",
                "maxLength":"256"
            },
            "links":{
                "description":"Links for item",
                "minItems":"1",
                "maxItems":"16",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:link"
                            ]
                        },
                        "rel":{
                            "description":"Relationship of href to the requested link",
                            "enum":[
                                "alternate",
                                "canonical",
                                "current",
                                "describedby",
                                "describes",
                                "enclosure",
                                "parent",
                                "related",
                                "self",
                                "first",
                                "last",
                                "next",
                                "previous",
                                "ogg://service"
                            ]
                        },
                        "href":{
                            "description":"An absolute URI for the link",
                            "type":"string",
                            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                            "minLength":"2",
                            "maxLength":"4095"
                        },
                        "mediaType":{
                            "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                            "type":"string",
                            "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                            "minLength":"6",
                            "maxLength":"255"
                        },
                        "description":{
                            "description":"A human-readable description that provides information and detail specific to this link.",
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"4095"
                        }
                    },
                    "required":[
                        "rel",
                        "href"
                    ],
                    "additionalProperties":false
                }
            }
        },
        "required":[
            "roleName",
            "links"
        ],
        "additionalProperties":false
    },
    "minItems":"0",
    "maxItems":"32767"
}

Nested Schema : items

Type: object

Show Source

links(required): array links

Minimum Number of Items: 1

Maximum Number of Items: 16

Links for item
roleName(required): string

Minimum Length: 1

Maximum Length: 256

Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$

Name of security role

{
    "type":"object",
    "properties":{
        "roleName":{
            "description":"Name of security role",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":"1",
            "maxLength":"256"
        },
        "links":{
            "description":"Links for item",
            "minItems":"1",
            "maxItems":"16",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:link"
                        ]
                    },
                    "rel":{
                        "description":"Relationship of href to the requested link",
                        "enum":[
                            "alternate",
                            "canonical",
                            "current",
                            "describedby",
                            "describes",
                            "enclosure",
                            "parent",
                            "related",
                            "self",
                            "first",
                            "last",
                            "next",
                            "previous",
                            "ogg://service"
                        ]
                    },
                    "href":{
                        "description":"An absolute URI for the link",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":"2",
                        "maxLength":"4095"
                    },
                    "mediaType":{
                        "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                        "type":"string",
                        "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                        "minLength":"6",
                        "maxLength":"255"
                    },
                    "description":{
                        "description":"A human-readable description that provides information and detail specific to this link.",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4095"
                    }
                },
                "required":[
                    "rel",
                    "href"
                ],
                "additionalProperties":false
            }
        }
    },
    "required":[
        "roleName",
        "links"
    ],
    "additionalProperties":false
}

Nested Schema : links

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 16

Links for item

Show Source

Array of: object items

{
    "description":"Links for item",
    "minItems":"1",
    "maxItems":"16",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:link"
                ]
            },
            "rel":{
                "description":"Relationship of href to the requested link",
                "enum":[
                    "alternate",
                    "canonical",
                    "current",
                    "describedby",
                    "describes",
                    "enclosure",
                    "parent",
                    "related",
                    "self",
                    "first",
                    "last",
                    "next",
                    "previous",
                    "ogg://service"
                ]
            },
            "href":{
                "description":"An absolute URI for the link",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":"2",
                "maxLength":"4095"
            },
            "mediaType":{
                "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                "type":"string",
                "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                "minLength":"6",
                "maxLength":"255"
            },
            "description":{
                "description":"A human-readable description that provides information and detail specific to this link.",
                "type":"string",
                "minLength":"1",
                "maxLength":"4095"
            }
        },
        "required":[
            "rel",
            "href"
        ],
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

$schema:

Allowed Values: [ "ogg:link" ]
description: string

Minimum Length: 1

Maximum Length: 4095

A human-readable description that provides information and detail specific to this link.
href(required): string

Minimum Length: 2

Maximum Length: 4095

Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

An absolute URI for the link
mediaType: string

Minimum Length: 6

Maximum Length: 255

Pattern: ^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$

Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)
rel(required):

Allowed Values: [ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]

Relationship of href to the requested link

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:link"
            ]
        },
        "rel":{
            "description":"Relationship of href to the requested link",
            "enum":[
                "alternate",
                "canonical",
                "current",
                "describedby",
                "describes",
                "enclosure",
                "parent",
                "related",
                "self",
                "first",
                "last",
                "next",
                "previous",
                "ogg://service"
            ]
        },
        "href":{
            "description":"An absolute URI for the link",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":"2",
            "maxLength":"4095"
        },
        "mediaType":{
            "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
            "type":"string",
            "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
            "minLength":"6",
            "maxLength":"255"
        },
        "description":{
            "description":"A human-readable description that provides information and detail specific to this link.",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/authorizations",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/authorizations",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/authorizations",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:roleCollection",
        "items":[
            {
                "links":[
                    {
                        "href":"http://localhost:9012/services/v2/authorizations/All",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "roleName":"All"
            },
            {
                "links":[
                    {
                        "href":"http://localhost:9012/services/v2/authorizations/User",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "roleName":"User"
            },
            {
                "links":[
                    {
                        "href":"http://localhost:9012/services/v2/authorizations/Operator",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "roleName":"Operator"
            },
            {
                "links":[
                    {
                        "href":"http://localhost:9012/services/v2/authorizations/Administrator",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "roleName":"Administrator"
            },
            {
                "links":[
                    {
                        "href":"http://localhost:9012/services/v2/authorizations/Security",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "roleName":"Security"
            }
        ]
    }
}