Class Authorization

Constructors

constructor

new Authorization(
transport: Transport,
options?: { timeoutMs?: number },
): Authorization
Parameters
- transport: Transport
- Optionaloptions: { timeoutMs?: number }
Returns Authorization

Methods

`Static`connect

connect(options?: { name?: string; timeoutMs?: number }): Authorization
Parameters
- Optionaloptions: { name?: string; timeoutMs?: number }
Returns Authorization

checkAccess

checkAccess(
action?: { name?: string; properties?: object },
resource?: { type?: string; id?: string; properties?: object },
): Promise<CheckAccessResponse>
Parameters
- Optionalaction: { name?: string; properties?: object }
- Optionalresource: { type?: string; id?: string; properties?: object }
Returns Promise<CheckAccessResponse>

checkAccessRaw

checkAccessRaw(
    request: {
        subject?: { type?: string; id?: string; properties?: object };
        action?: { name?: string; properties?: object };
        resource?: { type?: string; id?: string; properties?: object };
    },
): Promise<CheckAccessResponse>
Parameters
- request: {
      subject?: { type?: string; id?: string; properties?: object };
      action?: { name?: string; properties?: object };
      resource?: { type?: string; id?: string; properties?: object };
  }
Returns Promise<CheckAccessResponse>

checkAccessMany

checkAccessMany(
    requests: {
        subject?: { type?: string; id?: string; properties?: object };
        action?: { name?: string; properties?: object };
        resource?: { type?: string; id?: string; properties?: object };
    }[],
): Promise<CheckAccessManyResponse>
Parameters
- requests: {
      subject?: { type?: string; id?: string; properties?: object };
      action?: { name?: string; properties?: object };
      resource?: { type?: string; id?: string; properties?: object };
  }[]
Returns Promise<CheckAccessManyResponse>

checkAccessManyRaw

checkAccessManyRaw(
    request: {
        requests?: {
            subject?: { type?: string; id?: string; properties?: object };
            action?: { name?: string; properties?: object };
            resource?: { type?: string; id?: string; properties?: object };
        }[];
    },
): Promise<CheckAccessManyResponse>
Parameters
- request: {
      requests?: {
          subject?: { type?: string; id?: string; properties?: object };
          action?: { name?: string; properties?: object };
          resource?: { type?: string; id?: string; properties?: object };
      }[];
  }
Returns Promise<CheckAccessManyResponse>

listRelationships

listRelationships(
    pageSize: number,
    pageToken: string,
    filter?: {
        target?: {
            kind?:
                | { case: undefined; value?: undefined }
                | {
                    case: "subject";
                    value: { type?: string; id?: string; properties?: object };
                }
                | {
                    case: "resource";
                    value: { type?: string; id?: string; properties?: object };
                }
                | {
                    case: "subjectSet";
                    value: {
                        resource?: { type?: string; id?: string; properties?: object };
                        relation?: string;
                    };
                };
        };
        relation?: string;
        resource?: { type?: string; id?: string; properties?: object };
        targetType?: number;
        targetEntityType?: string;
        resourceType?: string;
        sourceLayer?: number;
    },
): Promise<ListRelationshipsResponse>
Parameters
- pageSize: number
- pageToken: string
- Optionalfilter: {
      target?: {
          kind?:
              | { case: undefined; value?: undefined }
              | {
                  case: "subject";
                  value: { type?: string; id?: string; properties?: object };
              }
              | {
                  case: "resource";
                  value: { type?: string; id?: string; properties?: object };
              }
              | {
                  case: "subjectSet";
                  value: {
                      resource?: { type?: string; id?: string; properties?: object };
                      relation?: string;
                  };
              };
      };
      relation?: string;
      resource?: { type?: string; id?: string; properties?: object };
      targetType?: number;
      targetEntityType?: string;
      resourceType?: string;
      sourceLayer?: number;
  }
Returns Promise<ListRelationshipsResponse>

listRelationshipsRaw

listRelationshipsRaw(
    request: {
        filter?: {
            target?: {
                kind?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "subject";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "resource";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "subjectSet";
                        value: {
                            resource?: {
                                type?: (...)
                                | (...);
                                id?: (...) | (...);
                                properties?: (...) | (...);
                            };
                            relation?: string;
                        };
                    };
            };
            relation?: string;
            resource?: { type?: string; id?: string; properties?: object };
            targetType?: number;
            targetEntityType?: string;
            resourceType?: string;
            sourceLayer?: number;
        };
        pageSize?: number;
        pageToken?: string;
    },
): Promise<ListRelationshipsResponse>
Parameters
- request: {
      filter?: {
          target?: {
              kind?:
                  | { case: undefined; value?: undefined }
                  | {
                      case: "subject";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "resource";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "subjectSet";
                      value: {
                          resource?: {
                              type?: (...)
                              | (...);
                              id?: (...) | (...);
                              properties?: (...) | (...);
                          };
                          relation?: string;
                      };
                  };
          };
          relation?: string;
          resource?: { type?: string; id?: string; properties?: object };
          targetType?: number;
          targetEntityType?: string;
          resourceType?: string;
          sourceLayer?: number;
      };
      pageSize?: number;
      pageToken?: string;
  }
Returns Promise<ListRelationshipsResponse>

addRelationship

addRelationship(
    relationship?: {
        tuple?: {
            target?: {
                kind?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "subject";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "resource";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "subjectSet";
                        value: {
                            resource?: { type?: ...; id?: ...; properties?: ... };
                            relation?: string;
                        };
                    };
            };
            relation?: string;
            resource?: { type?: string; id?: string; properties?: object };
        };
        properties?: object;
        sourceLayer?: number;
    },
): Promise<Relationship | undefined>
Parameters
- Optionalrelationship: {
      tuple?: {
          target?: {
              kind?:
                  | { case: undefined; value?: undefined }
                  | {
                      case: "subject";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "resource";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "subjectSet";
                      value: {
                          resource?: { type?: ...; id?: ...; properties?: ... };
                          relation?: string;
                      };
                  };
          };
          relation?: string;
          resource?: { type?: string; id?: string; properties?: object };
      };
      properties?: object;
      sourceLayer?: number;
  }
Returns Promise<Relationship | undefined>

addRelationshipRaw

addRelationshipRaw(
    request: {
        relationship?: {
            tuple?: {
                target?: {
                    kind?:
                        | { case: undefined; value?: undefined }
                        | {
                            case: "subject";
                            value: {
                                type?: (...) | (...);
                                id?: (...) | (...);
                                properties?: (...) | (...);
                            };
                        }
                        | {
                            case: "resource";
                            value: {
                                type?: (...)
                                | (...);
                                id?: (...) | (...);
                                properties?: (...) | (...);
                            };
                        }
                        | {
                            case: "subjectSet";
                            value: { resource?: (...)
                            | (...); relation?: (...) | (...) };
                        };
                };
                relation?: string;
                resource?: { type?: string; id?: string; properties?: object };
            };
            properties?: object;
            sourceLayer?: number;
        };
    },
): Promise<AddRelationshipResponse>
Parameters
- request: {
      relationship?: {
          tuple?: {
              target?: {
                  kind?:
                      | { case: undefined; value?: undefined }
                      | {
                          case: "subject";
                          value: {
                              type?: (...) | (...);
                              id?: (...) | (...);
                              properties?: (...) | (...);
                          };
                      }
                      | {
                          case: "resource";
                          value: {
                              type?: (...)
                              | (...);
                              id?: (...) | (...);
                              properties?: (...) | (...);
                          };
                      }
                      | {
                          case: "subjectSet";
                          value: { resource?: (...)
                          | (...); relation?: (...) | (...) };
                      };
              };
              relation?: string;
              resource?: { type?: string; id?: string; properties?: object };
          };
          properties?: object;
          sourceLayer?: number;
      };
  }
Returns Promise<AddRelationshipResponse>

deleteRelationship

deleteRelationship(
    relationshipTuple?: {
        target?: {
            kind?:
                | { case: undefined; value?: undefined }
                | {
                    case: "subject";
                    value: { type?: string; id?: string; properties?: object };
                }
                | {
                    case: "resource";
                    value: { type?: string; id?: string; properties?: object };
                }
                | {
                    case: "subjectSet";
                    value: {
                        resource?: { type?: string; id?: string; properties?: object };
                        relation?: string;
                    };
                };
        };
        relation?: string;
        resource?: { type?: string; id?: string; properties?: object };
    },
): Promise<DeleteRelationshipResponse>
Parameters
- OptionalrelationshipTuple: {
      target?: {
          kind?:
              | { case: undefined; value?: undefined }
              | {
                  case: "subject";
                  value: { type?: string; id?: string; properties?: object };
              }
              | {
                  case: "resource";
                  value: { type?: string; id?: string; properties?: object };
              }
              | {
                  case: "subjectSet";
                  value: {
                      resource?: { type?: string; id?: string; properties?: object };
                      relation?: string;
                  };
              };
      };
      relation?: string;
      resource?: { type?: string; id?: string; properties?: object };
  }
Returns Promise<DeleteRelationshipResponse>

deleteRelationshipRaw

deleteRelationshipRaw(
    request: {
        relationshipTuple?: {
            target?: {
                kind?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "subject";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "resource";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "subjectSet";
                        value: {
                            resource?: {
                                type?: (...)
                                | (...);
                                id?: (...) | (...);
                                properties?: (...) | (...);
                            };
                            relation?: string;
                        };
                    };
            };
            relation?: string;
            resource?: { type?: string; id?: string; properties?: object };
        };
    },
): Promise<DeleteRelationshipResponse>
Parameters
- request: {
      relationshipTuple?: {
          target?: {
              kind?:
                  | { case: undefined; value?: undefined }
                  | {
                      case: "subject";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "resource";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "subjectSet";
                      value: {
                          resource?: {
                              type?: (...)
                              | (...);
                              id?: (...) | (...);
                              properties?: (...) | (...);
                          };
                          relation?: string;
                      };
                  };
          };
          relation?: string;
          resource?: { type?: string; id?: string; properties?: object };
      };
  }
Returns Promise<DeleteRelationshipResponse>

setAuthorizationState

setAuthorizationState(
    relationships: {
        tuple?: {
            target?: {
                kind?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "subject";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "resource";
                        value: { type?: string; id?: string; properties?: object };
                    }
                    | {
                        case: "subjectSet";
                        value: {
                            resource?: { type?: ...; id?: ...; properties?: ... };
                            relation?: string;
                        };
                    };
            };
            relation?: string;
            resource?: { type?: string; id?: string; properties?: object };
        };
        properties?: object;
        sourceLayer?: number;
    }[],
    model?: {
        id?: string;
        version?: string;
        resourceTypes?: {
            name?: string;
            relations?: { name?: string; allowedTargets?: { kind?: ... }[] }[];
            actions?: { name?: string; relations?: string[] }[];
            sourceLayer?: number;
            defaultRole?: string;
        }[];
    },
): Promise<AuthorizationModelRef | undefined>
Parameters
- relationships: {
      tuple?: {
          target?: {
              kind?:
                  | { case: undefined; value?: undefined }
                  | {
                      case: "subject";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "resource";
                      value: { type?: string; id?: string; properties?: object };
                  }
                  | {
                      case: "subjectSet";
                      value: {
                          resource?: { type?: ...; id?: ...; properties?: ... };
                          relation?: string;
                      };
                  };
          };
          relation?: string;
          resource?: { type?: string; id?: string; properties?: object };
      };
      properties?: object;
      sourceLayer?: number;
  }[]
- Optionalmodel: {
      id?: string;
      version?: string;
      resourceTypes?: {
          name?: string;
          relations?: { name?: string; allowedTargets?: { kind?: ... }[] }[];
          actions?: { name?: string; relations?: string[] }[];
          sourceLayer?: number;
          defaultRole?: string;
      }[];
  }
Returns Promise<AuthorizationModelRef | undefined>

setAuthorizationStateRaw

setAuthorizationStateRaw(
    request: {
        model?: {
            id?: string;
            version?: string;
            resourceTypes?: {
                name?: string;
                relations?: { name?: string; allowedTargets?: (...)[] }[];
                actions?: { name?: string; relations?: (...)[] }[];
                sourceLayer?: number;
                defaultRole?: string;
            }[];
        };
        relationships?: {
            tuple?: {
                target?: {
                    kind?: | { case: undefined; value?: undefined }
                    | {
                        case: "subject";
                        value: { type?: ...; id?: ...; properties?: ... };
                    }
                    | {
                        case: "resource";
                        value: { type?: ...; id?: ...; properties?: ... };
                    }
                    | { case: "subjectSet"; value: { resource?: ...; relation?: ... } };
                };
                relation?: string;
                resource?: { type?: string; id?: string; properties?: object };
            };
            properties?: object;
            sourceLayer?: number;
        }[];
    },
): Promise<SetAuthorizationStateResponse>
Parameters
- request: {
      model?: {
          id?: string;
          version?: string;
          resourceTypes?: {
              name?: string;
              relations?: { name?: string; allowedTargets?: (...)[] }[];
              actions?: { name?: string; relations?: (...)[] }[];
              sourceLayer?: number;
              defaultRole?: string;
          }[];
      };
      relationships?: {
          tuple?: {
              target?: {
                  kind?: | { case: undefined; value?: undefined }
                  | { case: "subject"; value: { type?: ...; id?: ...; properties?: ... } }
                  | {
                      case: "resource";
                      value: { type?: ...; id?: ...; properties?: ... };
                  }
                  | { case: "subjectSet"; value: { resource?: ...; relation?: ... } };
              };
              relation?: string;
              resource?: { type?: string; id?: string; properties?: object };
          };
          properties?: object;
          sourceLayer?: number;
      }[];
  }
Returns Promise<SetAuthorizationStateResponse>

getActiveModelRef

getActiveModelRef(): Promise<AuthorizationModelRef | undefined>
Returns Promise<AuthorizationModelRef | undefined>

getActiveModelRefRaw

getActiveModelRefRaw(): Promise<GetActiveModelRefResponse>
Returns Promise<GetActiveModelRefResponse>

setActiveModel

setActiveModel(
    model?: {
        id?: string;
        version?: string;
        resourceTypes?: {
            name?: string;
            relations?: { name?: string; allowedTargets?: { kind?: ... }[] }[];
            actions?: { name?: string; relations?: string[] }[];
            sourceLayer?: number;
            defaultRole?: string;
        }[];
    },
): Promise<AuthorizationModelRef | undefined>
Parameters
- Optionalmodel: {
      id?: string;
      version?: string;
      resourceTypes?: {
          name?: string;
          relations?: { name?: string; allowedTargets?: { kind?: ... }[] }[];
          actions?: { name?: string; relations?: string[] }[];
          sourceLayer?: number;
          defaultRole?: string;
      }[];
  }
Returns Promise<AuthorizationModelRef | undefined>

setActiveModelRaw

setActiveModelRaw(
    request: {
        model?: {
            id?: string;
            version?: string;
            resourceTypes?: {
                name?: string;
                relations?: { name?: string; allowedTargets?: (...)[] }[];
                actions?: { name?: string; relations?: (...)[] }[];
                sourceLayer?: number;
                defaultRole?: string;
            }[];
        };
    },
): Promise<SetActiveModelResponse>
Parameters
- request: {
      model?: {
          id?: string;
          version?: string;
          resourceTypes?: {
              name?: string;
              relations?: { name?: string; allowedTargets?: (...)[] }[];
              actions?: { name?: string; relations?: (...)[] }[];
              sourceLayer?: number;
              defaultRole?: string;
          }[];
      };
  }
Returns Promise<SetActiveModelResponse>

listActiveModelResourceTypes

listActiveModelResourceTypes(
    pageSize: number,
    pageToken: string,
    filter?: { name?: string; sourceLayer?: number },
): Promise<ListActiveModelResourceTypesResponse>
Parameters
- pageSize: number
- pageToken: string
- Optionalfilter: { name?: string; sourceLayer?: number }
Returns Promise<ListActiveModelResourceTypesResponse>

listActiveModelResourceTypesRaw

listActiveModelResourceTypesRaw(
    request: {
        filter?: { name?: string; sourceLayer?: number };
        pageSize?: number;
        pageToken?: string;
    },
): Promise<ListActiveModelResourceTypesResponse>
Parameters
- request: {
      filter?: { name?: string; sourceLayer?: number };
      pageSize?: number;
      pageToken?: string;
  }
Returns Promise<ListActiveModelResourceTypesResponse>

Class Authorization

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Authorization

Methods

Staticconnect

Parameters

Returns Authorization

checkAccess

Parameters

Returns Promise<CheckAccessResponse>

checkAccessRaw

Parameters

Returns Promise<CheckAccessResponse>

checkAccessMany

Parameters

Returns Promise<CheckAccessManyResponse>

checkAccessManyRaw

Parameters

Returns Promise<CheckAccessManyResponse>

listRelationships

Parameters

Returns Promise<ListRelationshipsResponse>

listRelationshipsRaw

Parameters

Returns Promise<ListRelationshipsResponse>

addRelationship

Parameters

Returns Promise<Relationship | undefined>

addRelationshipRaw

Parameters

Returns Promise<AddRelationshipResponse>

deleteRelationship

Parameters

Returns Promise<DeleteRelationshipResponse>

deleteRelationshipRaw

Parameters

Returns Promise<DeleteRelationshipResponse>

setAuthorizationState

Parameters

Returns Promise<AuthorizationModelRef | undefined>

setAuthorizationStateRaw

Parameters

Returns Promise<SetAuthorizationStateResponse>

getActiveModelRef

Returns Promise<AuthorizationModelRef | undefined>

getActiveModelRefRaw

Returns Promise<GetActiveModelRefResponse>

setActiveModel

Parameters

Returns Promise<AuthorizationModelRef | undefined>

setActiveModelRaw

Parameters

Returns Promise<SetActiveModelResponse>

listActiveModelResourceTypes

Parameters

Returns Promise<ListActiveModelResourceTypesResponse>

listActiveModelResourceTypesRaw

Parameters

Returns Promise<ListActiveModelResourceTypesResponse>

Settings

On This Page

`Static`connect