Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Get Unoffered Schema

GET
/iam/v1/schemas/{kind}/{resource}
curl --request GET \
--url https://example.com/iam/v1/schemas/example/example

Answers a request for a kind this service does not offer, either for every resource (/iam/v1/schemas/{kind}) or for one (/iam/v1/schemas/{kind}/{resource}). It always fails with NOT_FOUND, naming the requested kind and the offered kinds; it never returns another kind’s schema.

kind
required
string

Kind

The schema kind requested.

resource
required
string

Resource

The resource token requested. Empty when the request names every resource of the kind.

OK

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}