Organization admin check service (gRPC)#

Checks authorization preconditions rather than creating or modifying administrator grants.

Endpoints#

Check organization admin#

gRPC /nominal.authorization.permissions.v1.OrganizationAdminCheckService/CheckOrganizationAdmin

Checks that the caller is an admin of their current org. Returns an empty response when the caller is. Changes nothing.

Errors:

  • PERMISSION_DENIED: the caller is not an admin of their current org.

Request: CheckOrganizationAdminRequest

A message with no fields.

Response: CheckOrganizationAdminResponse

A message with no fields.

Request

import grpc
from nominal.protos.authorization.permissions.v1 import organization_admin_checks_pb2, organization_admin_checks_pb2_grpc

channel = grpc.secure_channel("api.gov.nominal.io:443", grpc.ssl_channel_credentials())
organization_admin_check_service = organization_admin_checks_pb2_grpc.OrganizationAdminCheckServiceStub(channel)
auth = [("authorization", "Bearer <api key>")]

request = organization_admin_checks_pb2.CheckOrganizationAdminRequest()
response = organization_admin_check_service.CheckOrganizationAdmin(request, metadata=auth)
print(response)
package main

import (
	"context"
	"crypto/tls"
	"fmt"
	"log"

	permissionsv1 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/authorization/permissions/v1"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
)

func main() {
	conn, err := grpc.NewClient("api.gov.nominal.io:443",
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()
	organizationAdminCheckService := permissionsv1.NewOrganizationAdminCheckServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &permissionsv1.CheckOrganizationAdminRequest{}
	response, err := organizationAdminCheckService.CheckOrganizationAdmin(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Page design based on Scalar, MIT License.