REST API for Oracle Web Services Manager

Get TokenAttributeRule(s)

get

/v2/trust/{trustname}/attributerule

Get a list of TokenAttributeRules of a named {trustname} Trust document. These TokenAttributeRule can be further filtered by one or more query parameters issuername, or identifier in the request URL, for example, ?issuername=http://abc.com&identifier=myId3

Request

Supported Media Types

application/json

Path Parameters

trustname(required): string

trustname of the Trust document.

Query Parameters

identifier: string

identifier of the TokenAttributeRule
issuername: string

issuername of the TokenAttributeRule

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : schema

Type: array

Show Source

Array of: object TokenAttributeRule

TokenAttributeRule Model Object

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

Nested Schema : TokenAttributeRule

Type: object

TokenAttributeRule Model Object

Show Source

attributes: array attributes

The list of all TokenAttribute sub objects
identifier(required): string

Identifier of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule

Example: identifier1
issuername(required): string

Name of the token issuer of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule

Example: http://abc.com
nameid: object NameId

NameId Model Object
proxy: object Proxy

Proxy Model Object.
virtualuser: object VirtualUser

VirtualUser Model Object.

{
    "type":"object",
    "required":[
        "identifier",
        "issuername"
    ],
    "properties":{
        "issuername":{
            "type":"string",
            "example":"http://abc.com",
            "description":"Name of the token issuer of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule"
        },
        "identifier":{
            "type":"string",
            "example":"identifier1",
            "description":"Identifier of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule"
        },
        "proxy":{
            "example":"true",
            "description":"The Proxy sub object",
            "$ref":"#/definitions/Proxy"
        },
        "virtualuser":{
            "description":"The VirtualUser sub object",
            "$ref":"#/definitions/VirtualUser"
        },
        "nameid":{
            "description":"The NameIdsub object",
            "$ref":"#/definitions/NameId"
        },
        "attributes":{
            "type":"array",
            "description":"The list of all TokenAttribute sub objects",
            "items":{
                "$ref":"#/definitions/TokenAttribute"
            }
        }
    },
    "description":"TokenAttributeRule Model Object"
}

Nested Schema : attributes

Type: array

The list of all TokenAttribute sub objects

Show Source

Array of: object TokenAttribute

TokenAttribute Model Object

{
    "type":"array",
    "description":"The list of all TokenAttribute sub objects",
    "items":{
        "$ref":"#/definitions/TokenAttribute"
    }
}

Nested Schema : NameId

Type: object

NameId Model Object

Show Source

filter: array filter

Filter
mapping: object AttributeMapping

AttributeMapping Model Object.
name(required): string

Name of a NameId

Example: myTokenAttributeName1

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "filter":{
            "type":"array",
            "example":"['filter1', 'filter2']",
            "description":"Filter",
            "items":{
                "type":"string"
            }
        },
        "mapping":{
            "description":"The AttributeMappingsub object",
            "$ref":"#/definitions/AttributeMapping"
        },
        "name":{
            "type":"string",
            "example":"myTokenAttributeName1",
            "description":"Name of a NameId"
        }
    },
    "description":"NameId Model Object"
}

Nested Schema : Proxy

Type: object

Proxy Model Object.

Show Source

proxyhost: string

The host of a Proxy in a TokenAttributeRule
proxyport: string

The port of a Proxy in a TokenAttributeRule

{
    "type":"object",
    "properties":{
        "proxyhost":{
            "type":"string",
            "description":"The host of a Proxy in a TokenAttributeRule"
        },
        "proxyport":{
            "type":"string",
            "description":"The port of a Proxy in a TokenAttributeRule"
        }
    },
    "description":"Proxy Model Object."
}

Nested Schema : VirtualUser

Type: object

VirtualUser Model Object.

Show Source

defaultRoles: array defaultRoles

An array of default roles of a VirtualUser
enabled: string

Allowed Values: [ "true", "false" ]

Indicates if a VirtualUser is enabled or not.

Example: true
tokenRoleAttributes: array tokenRoleAttributes
tokenRoleMappings: array tokenRoleMappings

A list of TokenRoleMapping sub objects

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"string",
            "example":"true",
            "description":"Indicates if a VirtualUser is enabled or not.",
            "enum":[
                "true",
                "false"
            ]
        },
        "defaultRoles":{
            "type":"array",
            "description":"An array of default roles of a VirtualUser",
            "items":{
                "type":"string"
            }
        },
        "tokenRoleMappings":{
            "type":"array",
            "description":"A list of TokenRoleMapping sub objects",
            "items":{
                "$ref":"#/definitions/TokenRoleMapping"
            }
        },
        "tokenRoleAttributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"VirtualUser Model Object."
}

Nested Schema : TokenAttribute

Type: object

TokenAttribute Model Object

Show Source

filter: array filter

Filter
mapping: object AttributeMapping

AttributeMapping Model Object.
name(required): string

Name of a TokenAttribute

Example: myTokenAttributeName1

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "filter":{
            "type":"array",
            "example":"['filter1', 'filter2']",
            "description":"Filter",
            "items":{
                "type":"string"
            }
        },
        "mapping":{
            "description":"The AttributeMappingsub object",
            "$ref":"#/definitions/AttributeMapping"
        },
        "name":{
            "type":"string",
            "example":"myTokenAttributeName1",
            "description":"Name of a TokenAttribute"
        }
    },
    "description":"TokenAttribute Model Object"
}

Nested Schema : filter

Type: array

Filter

Show Source

Array of: string

{
    "type":"array",
    "example":"['filter1', 'filter2']",
    "description":"Filter",
    "items":{
        "type":"string"
    }
}

Example:

['filter1', 'filter2']

Nested Schema : AttributeMapping

Type: object

AttributeMapping Model Object.

Show Source

userAttribute(required): string

User attribute

Example: myUserAttr1
userMappingAttribute(required): string

User mapping attribute.

Example: myUserMappingAttr1

{
    "type":"object",
    "required":[
        "userAttribute",
        "userMappingAttribute"
    ],
    "properties":{
        "userAttribute":{
            "type":"string",
            "example":"myUserAttr1",
            "description":"User attribute"
        },
        "userMappingAttribute":{
            "type":"string",
            "example":"myUserMappingAttr1",
            "description":"User mapping attribute."
        }
    },
    "description":"AttributeMapping Model Object."
}

Nested Schema : filter

Type: array

Filter

Show Source

Array of: string

{
    "type":"array",
    "example":"['filter1', 'filter2']",
    "description":"Filter",
    "items":{
        "type":"string"
    }
}

Example:

['filter1', 'filter2']

Nested Schema : defaultRoles

Type: array

An array of default roles of a VirtualUser

Show Source

Array of: string

{
    "type":"array",
    "description":"An array of default roles of a VirtualUser",
    "items":{
        "type":"string"
    }
}

Nested Schema : tokenRoleAttributes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : tokenRoleMappings

Type: array

A list of TokenRoleMapping sub objects

Show Source

Array of: object TokenRoleMapping

TokenRoleMapping Model Object.

{
    "type":"array",
    "description":"A list of TokenRoleMapping sub objects",
    "items":{
        "$ref":"#/definitions/TokenRoleMapping"
    }
}

Nested Schema : TokenRoleMapping

Type: object

TokenRoleMapping Model Object.

Show Source

mappingRoles(required): array mappingRoles

List of role mappings.
tokenRole(required): string

Role of the token.

Example: sampleTRole1

{
    "type":"object",
    "required":[
        "mappingRoles",
        "tokenRole"
    ],
    "properties":{
        "tokenRole":{
            "type":"string",
            "example":"sampleTRole1",
            "description":"Role of the token."
        },
        "mappingRoles":{
            "type":"array",
            "example":"['roleMapping1', 'roleMpping2']",
            "description":"List of role mappings.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"TokenRoleMapping Model Object."
}

Nested Schema : mappingRoles

Type: array

List of role mappings.

Show Source

Array of: string

{
    "type":"array",
    "example":"['roleMapping1', 'roleMpping2']",
    "description":"List of role mappings.",
    "items":{
        "type":"string"
    }
}

Example:

['roleMapping1', 'roleMpping2']

400 Response

User bad request, please correct input data and try again.

Root Schema : ResponseStatus

Type: object

ResponseStatus model object.

Show Source

MESSAGE: string

Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause.

Example: PolicySets [myPolicyset1, myPolicyset2] are successfully created.
STATUSCODE: string

Allowed Values: [ "20001", "20002", "20003", "20004", "20005", "20011", "20012", "20013", "20014", "20021", "20023", "20024", "20032", "20033", "20034", "20035", "20042", "20043", "20044", "20051", "20052", "20053", "20054", "20055", "20061", "20062", "20063", "20064", "20065", "20071", "20072", "20073", "20074", "20075", "20081", "20082", "20083", "20084", "20085", "20091", "20092", "20093", "20094", "20095", "20101", "20102", "20103", "20104", "20105", "20111", "20112", "20113", "20114", "20115", "20121", "20122", "20123", "20124", "20125", "20131", "20132", "20133", "20134", "20135", "20141", "20142", "20143", "20144", "20145", "20151", "20152", "20153", "20154", "20155", "20161", "20162", "20163", "20164", "20165", "20171", "20172", "20173", "20174", "20175", "40001", "40002", "40003", "40004", "40011", "40012", "40013", "40014", "40021", "40023", "40024", "40032", "40033", "40042", "40043", "40044", "40051", "40052", "40053", "40054", "40061", "40062", "40063", "40064", "40071", "40072", "40073", "40074", "40081", "40082", "40083", "40084", "40091", "40092", "40093", "40094", "40101", "40102", "40103", "40104", "40111", "40112", "40113", "40114", "40121", "40122", "40123", "40124", "40131", "40132", "40133", "40134", "40141", "40142", "40143", "40144", "40151", "40152", "40153", "40154", "40161", "40162", "40163", "40164", "40171", "40172", "40173", "40174" ]

OWSM Rest API status code for operations on various APIs. One can write tests and parse the status code based on the rules below. If you plan to process the status code programmatically, you can access the OWSM source file for the constants defined at: oracle.wsm.resources.rest.RestMessageID.java. Status Code Pattern:first digit from left indicates the operation status, 2=successful, 4=failed last digit indicate operation 1=POST, 2=PUT, 3=GET, 4=DELETE, 5=DELETE NONE. second, third, fourth digits from left are used for OWSM Rest API Resource types: 000=PolicySet, 001=PolicyReference, 002=ConfigOverride, 003=Configuration, 004=Repository (not used yet), 005=Trust, 006=Issuer, 007=TrustedKey, 008=KeyIdentifier, 009=RelyingParty, 010=AttributeRule, 011=Attribute, 012=VirtualUser, 013=RoleMapping, 014=Mapping, 015=NamedID, 016=DiscoveryInfo, 017=Proxy

Example: 20001

{
    "type":"object",
    "properties":{
        "STATUSCODE":{
            "type":"string",
            "example":"20001",
            "description":"OWSM Rest API status code for operations on various APIs. One can write tests and parse the status code based on the rules below. If you plan to process the status code programmatically, you can access the OWSM source file for the constants defined at: oracle.wsm.resources.rest.RestMessageID.java. Status Code Pattern:first digit from left indicates the operation status, 2=successful, 4=failed last digit indicate operation 1=POST, 2=PUT, 3=GET, 4=DELETE, 5=DELETE NONE. second, third, fourth digits from left are used for OWSM Rest API Resource types: 000=PolicySet, 001=PolicyReference, 002=ConfigOverride, 003=Configuration, 004=Repository (not used yet),  005=Trust, 006=Issuer, 007=TrustedKey, 008=KeyIdentifier, 009=RelyingParty, 010=AttributeRule,  011=Attribute, 012=VirtualUser, 013=RoleMapping, 014=Mapping, 015=NamedID, 016=DiscoveryInfo, 017=Proxy",
            "enum":[
                "20001",
                "20002",
                "20003",
                "20004",
                "20005",
                "20011",
                "20012",
                "20013",
                "20014",
                "20021",
                "20023",
                "20024",
                "20032",
                "20033",
                "20034",
                "20035",
                "20042",
                "20043",
                "20044",
                "20051",
                "20052",
                "20053",
                "20054",
                "20055",
                "20061",
                "20062",
                "20063",
                "20064",
                "20065",
                "20071",
                "20072",
                "20073",
                "20074",
                "20075",
                "20081",
                "20082",
                "20083",
                "20084",
                "20085",
                "20091",
                "20092",
                "20093",
                "20094",
                "20095",
                "20101",
                "20102",
                "20103",
                "20104",
                "20105",
                "20111",
                "20112",
                "20113",
                "20114",
                "20115",
                "20121",
                "20122",
                "20123",
                "20124",
                "20125",
                "20131",
                "20132",
                "20133",
                "20134",
                "20135",
                "20141",
                "20142",
                "20143",
                "20144",
                "20145",
                "20151",
                "20152",
                "20153",
                "20154",
                "20155",
                "20161",
                "20162",
                "20163",
                "20164",
                "20165",
                "20171",
                "20172",
                "20173",
                "20174",
                "20175",
                "40001",
                "40002",
                "40003",
                "40004",
                "40011",
                "40012",
                "40013",
                "40014",
                "40021",
                "40023",
                "40024",
                "40032",
                "40033",
                "40042",
                "40043",
                "40044",
                "40051",
                "40052",
                "40053",
                "40054",
                "40061",
                "40062",
                "40063",
                "40064",
                "40071",
                "40072",
                "40073",
                "40074",
                "40081",
                "40082",
                "40083",
                "40084",
                "40091",
                "40092",
                "40093",
                "40094",
                "40101",
                "40102",
                "40103",
                "40104",
                "40111",
                "40112",
                "40113",
                "40114",
                "40121",
                "40122",
                "40123",
                "40124",
                "40131",
                "40132",
                "40133",
                "40134",
                "40141",
                "40142",
                "40143",
                "40144",
                "40151",
                "40152",
                "40153",
                "40154",
                "40161",
                "40162",
                "40163",
                "40164",
                "40171",
                "40172",
                "40173",
                "40174"
            ]
        },
        "MESSAGE":{
            "type":"string",
            "example":"PolicySets [myPolicyset1, myPolicyset2] are successfully created.",
            "description":"Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause."
        }
    },
    "description":"ResponseStatus model object."
}

500 Response

Operation failed with unexpected error.

Root Schema : ResponseStatus

Type: object

ResponseStatus model object.

Show Source

MESSAGE: string

Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause.

Example: PolicySets [myPolicyset1, myPolicyset2] are successfully created.
STATUSCODE: string

Allowed Values: [ "20001", "20002", "20003", "20004", "20005", "20011", "20012", "20013", "20014", "20021", "20023", "20024", "20032", "20033", "20034", "20035", "20042", "20043", "20044", "20051", "20052", "20053", "20054", "20055", "20061", "20062", "20063", "20064", "20065", "20071", "20072", "20073", "20074", "20075", "20081", "20082", "20083", "20084", "20085", "20091", "20092", "20093", "20094", "20095", "20101", "20102", "20103", "20104", "20105", "20111", "20112", "20113", "20114", "20115", "20121", "20122", "20123", "20124", "20125", "20131", "20132", "20133", "20134", "20135", "20141", "20142", "20143", "20144", "20145", "20151", "20152", "20153", "20154", "20155", "20161", "20162", "20163", "20164", "20165", "20171", "20172", "20173", "20174", "20175", "40001", "40002", "40003", "40004", "40011", "40012", "40013", "40014", "40021", "40023", "40024", "40032", "40033", "40042", "40043", "40044", "40051", "40052", "40053", "40054", "40061", "40062", "40063", "40064", "40071", "40072", "40073", "40074", "40081", "40082", "40083", "40084", "40091", "40092", "40093", "40094", "40101", "40102", "40103", "40104", "40111", "40112", "40113", "40114", "40121", "40122", "40123", "40124", "40131", "40132", "40133", "40134", "40141", "40142", "40143", "40144", "40151", "40152", "40153", "40154", "40161", "40162", "40163", "40164", "40171", "40172", "40173", "40174" ]

OWSM Rest API status code for operations on various APIs. One can write tests and parse the status code based on the rules below. If you plan to process the status code programmatically, you can access the OWSM source file for the constants defined at: oracle.wsm.resources.rest.RestMessageID.java. Status Code Pattern:first digit from left indicates the operation status, 2=successful, 4=failed last digit indicate operation 1=POST, 2=PUT, 3=GET, 4=DELETE, 5=DELETE NONE. second, third, fourth digits from left are used for OWSM Rest API Resource types: 000=PolicySet, 001=PolicyReference, 002=ConfigOverride, 003=Configuration, 004=Repository (not used yet), 005=Trust, 006=Issuer, 007=TrustedKey, 008=KeyIdentifier, 009=RelyingParty, 010=AttributeRule, 011=Attribute, 012=VirtualUser, 013=RoleMapping, 014=Mapping, 015=NamedID, 016=DiscoveryInfo, 017=Proxy

Example: 20001

{
    "type":"object",
    "properties":{
        "STATUSCODE":{
            "type":"string",
            "example":"20001",
            "description":"OWSM Rest API status code for operations on various APIs. One can write tests and parse the status code based on the rules below. If you plan to process the status code programmatically, you can access the OWSM source file for the constants defined at: oracle.wsm.resources.rest.RestMessageID.java. Status Code Pattern:first digit from left indicates the operation status, 2=successful, 4=failed last digit indicate operation 1=POST, 2=PUT, 3=GET, 4=DELETE, 5=DELETE NONE. second, third, fourth digits from left are used for OWSM Rest API Resource types: 000=PolicySet, 001=PolicyReference, 002=ConfigOverride, 003=Configuration, 004=Repository (not used yet),  005=Trust, 006=Issuer, 007=TrustedKey, 008=KeyIdentifier, 009=RelyingParty, 010=AttributeRule,  011=Attribute, 012=VirtualUser, 013=RoleMapping, 014=Mapping, 015=NamedID, 016=DiscoveryInfo, 017=Proxy",
            "enum":[
                "20001",
                "20002",
                "20003",
                "20004",
                "20005",
                "20011",
                "20012",
                "20013",
                "20014",
                "20021",
                "20023",
                "20024",
                "20032",
                "20033",
                "20034",
                "20035",
                "20042",
                "20043",
                "20044",
                "20051",
                "20052",
                "20053",
                "20054",
                "20055",
                "20061",
                "20062",
                "20063",
                "20064",
                "20065",
                "20071",
                "20072",
                "20073",
                "20074",
                "20075",
                "20081",
                "20082",
                "20083",
                "20084",
                "20085",
                "20091",
                "20092",
                "20093",
                "20094",
                "20095",
                "20101",
                "20102",
                "20103",
                "20104",
                "20105",
                "20111",
                "20112",
                "20113",
                "20114",
                "20115",
                "20121",
                "20122",
                "20123",
                "20124",
                "20125",
                "20131",
                "20132",
                "20133",
                "20134",
                "20135",
                "20141",
                "20142",
                "20143",
                "20144",
                "20145",
                "20151",
                "20152",
                "20153",
                "20154",
                "20155",
                "20161",
                "20162",
                "20163",
                "20164",
                "20165",
                "20171",
                "20172",
                "20173",
                "20174",
                "20175",
                "40001",
                "40002",
                "40003",
                "40004",
                "40011",
                "40012",
                "40013",
                "40014",
                "40021",
                "40023",
                "40024",
                "40032",
                "40033",
                "40042",
                "40043",
                "40044",
                "40051",
                "40052",
                "40053",
                "40054",
                "40061",
                "40062",
                "40063",
                "40064",
                "40071",
                "40072",
                "40073",
                "40074",
                "40081",
                "40082",
                "40083",
                "40084",
                "40091",
                "40092",
                "40093",
                "40094",
                "40101",
                "40102",
                "40103",
                "40104",
                "40111",
                "40112",
                "40113",
                "40114",
                "40121",
                "40122",
                "40123",
                "40124",
                "40131",
                "40132",
                "40133",
                "40134",
                "40141",
                "40142",
                "40143",
                "40144",
                "40151",
                "40152",
                "40153",
                "40154",
                "40161",
                "40162",
                "40163",
                "40164",
                "40171",
                "40172",
                "40173",
                "40174"
            ]
        },
        "MESSAGE":{
            "type":"string",
            "example":"PolicySets [myPolicyset1, myPolicyset2] are successfully created.",
            "description":"Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause."
        }
    },
    "description":"ResponseStatus model object."
}